This will allow us to easily expand it to be used for generator unit-tests. PiperOrigin-RevId: 542651612pull/13092/head
Mike Kruskal
2 years ago
committed by
Copybara-Service
parent
6d79d13e47
commit
8f84e43231
5 changed files with 477 additions and 287 deletions
@ -0,0 +1,200 @@ |
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2023 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
#include "google/protobuf/compiler/command_line_interface_tester.h" |
||||
|
||||
#include <memory> |
||||
#include <string> |
||||
#include <vector> |
||||
|
||||
#include "google/protobuf/testing/file.h" |
||||
#include "google/protobuf/testing/file.h" |
||||
#include <gmock/gmock.h> |
||||
#include "google/protobuf/testing/googletest.h" |
||||
#include "absl/log/absl_check.h" |
||||
#include "absl/status/status.h" |
||||
#include "absl/strings/str_cat.h" |
||||
#include "absl/strings/str_replace.h" |
||||
#include "absl/strings/str_split.h" |
||||
|
||||
namespace google { |
||||
namespace protobuf { |
||||
namespace compiler { |
||||
namespace { |
||||
|
||||
using ::testing::HasSubstr; |
||||
|
||||
bool FileExists(const std::string& path) { |
||||
return File::Exists(path); |
||||
} |
||||
|
||||
} // namespace
|
||||
|
||||
CommandLineInterfaceTester::CommandLineInterfaceTester() { |
||||
temp_directory_ = absl::StrCat(TestTempDir(), "/proto2_cli_test_temp"); |
||||
|
||||
// If the temp directory already exists, it must be left over from a
|
||||
// previous run. Delete it.
|
||||
if (FileExists(temp_directory_)) { |
||||
File::DeleteRecursively(temp_directory_, NULL, NULL); |
||||
} |
||||
|
||||
// Create the temp directory.
|
||||
ABSL_CHECK_OK(File::CreateDir(temp_directory_, 0777)); |
||||
} |
||||
|
||||
CommandLineInterfaceTester::~CommandLineInterfaceTester() { |
||||
// Delete the temp directory.
|
||||
if (FileExists(temp_directory_)) { |
||||
File::DeleteRecursively(temp_directory_, NULL, NULL); |
||||
} |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::RunProtoc(absl::string_view command) { |
||||
RunProtocWithArgs(absl::StrSplit(command, ' ', absl::SkipEmpty())); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::RunProtocWithArgs( |
||||
std::vector<std::string> args) { |
||||
std::vector<const char*> argv(args.size()); |
||||
|
||||
for (size_t i = 0; i < args.size(); i++) { |
||||
args[i] = absl::StrReplaceAll(args[i], {{"$tmpdir", temp_directory_}}); |
||||
argv[i] = args[i].c_str(); |
||||
} |
||||
|
||||
// TODO(jieluo): Cygwin doesn't work well if we try to capture stderr and
|
||||
// stdout at the same time. Need to figure out why and add this capture back
|
||||
// for Cygwin.
|
||||
#if !defined(__CYGWIN__) |
||||
CaptureTestStdout(); |
||||
#endif |
||||
CaptureTestStderr(); |
||||
|
||||
return_code_ = cli_.Run(static_cast<int>(args.size()), argv.data()); |
||||
|
||||
error_text_ = GetCapturedTestStderr(); |
||||
#if !defined(__CYGWIN__) |
||||
captured_stdout_ = GetCapturedTestStdout(); |
||||
#endif |
||||
} |
||||
|
||||
// -------------------------------------------------------------------
|
||||
|
||||
void CommandLineInterfaceTester::CreateTempFile(absl::string_view name, |
||||
absl::string_view contents) { |
||||
// Create parent directory, if necessary.
|
||||
std::string::size_type slash_pos = name.find_last_of('/'); |
||||
if (slash_pos != std::string::npos) { |
||||
absl::string_view dir = name.substr(0, slash_pos); |
||||
if (!FileExists(absl::StrCat(temp_directory_, "/", dir))) { |
||||
ABSL_CHECK_OK(File::RecursivelyCreateDir( |
||||
absl::StrCat(temp_directory_, "/", dir), 0777)); |
||||
} |
||||
} |
||||
|
||||
// Write file.
|
||||
std::string full_name = absl::StrCat(temp_directory_, "/", name); |
||||
ABSL_CHECK_OK(File::SetContents( |
||||
full_name, absl::StrReplaceAll(contents, {{"$tmpdir", temp_directory_}}), |
||||
true)); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::CreateTempDir(absl::string_view name) { |
||||
ABSL_CHECK_OK(File::RecursivelyCreateDir( |
||||
absl::StrCat(temp_directory_, "/", name), 0777)); |
||||
} |
||||
|
||||
// -------------------------------------------------------------------
|
||||
|
||||
void CommandLineInterfaceTester::ExpectNoErrors() { |
||||
EXPECT_EQ(0, return_code_); |
||||
EXPECT_EQ("", error_text_); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::ExpectErrorText( |
||||
absl::string_view expected_text) { |
||||
EXPECT_NE(0, return_code_); |
||||
EXPECT_EQ(absl::StrReplaceAll(expected_text, {{"$tmpdir", temp_directory_}}), |
||||
error_text_); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::ExpectErrorSubstring( |
||||
absl::string_view expected_substring) { |
||||
EXPECT_NE(0, return_code_); |
||||
EXPECT_THAT(error_text_, HasSubstr(expected_substring)); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::ExpectWarningSubstring( |
||||
absl::string_view expected_substring) { |
||||
EXPECT_EQ(0, return_code_); |
||||
EXPECT_THAT(error_text_, HasSubstr(expected_substring)); |
||||
} |
||||
|
||||
#if defined(_WIN32) && !defined(__CYGWIN__) |
||||
bool CommandLineInterfaceTester::HasAlternateErrorSubstring( |
||||
const std::string& expected_substring) { |
||||
EXPECT_NE(0, return_code_); |
||||
return error_text_.find(expected_substring) != std::string::npos; |
||||
} |
||||
#endif // _WIN32 && !__CYGWIN__
|
||||
|
||||
void CommandLineInterfaceTester::ExpectCapturedStdout( |
||||
absl::string_view expected_text) { |
||||
EXPECT_EQ(expected_text, captured_stdout_); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester:: |
||||
ExpectCapturedStdoutSubstringWithZeroReturnCode( |
||||
absl::string_view expected_substring) { |
||||
EXPECT_EQ(0, return_code_); |
||||
EXPECT_THAT(captured_stdout_, HasSubstr(expected_substring)); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester:: |
||||
ExpectCapturedStderrSubstringWithZeroReturnCode( |
||||
absl::string_view expected_substring) { |
||||
EXPECT_EQ(0, return_code_); |
||||
EXPECT_THAT(error_text_, HasSubstr(expected_substring)); |
||||
} |
||||
|
||||
void CommandLineInterfaceTester::ExpectFileContent(absl::string_view filename, |
||||
absl::string_view content) { |
||||
std::string path = absl::StrCat(temp_directory_, "/", filename); |
||||
std::string file_contents; |
||||
ABSL_CHECK_OK(File::GetContents(path, &file_contents, true)); |
||||
|
||||
EXPECT_EQ(absl::StrReplaceAll(content, {{"$tmpdir", temp_directory_}}), |
||||
file_contents); |
||||
} |
||||
|
||||
} // namespace compiler
|
||||
} // namespace protobuf
|
||||
} // namespace google
|
||||
@ -0,0 +1,178 @@ |
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2023 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
#ifndef GOOGLE_PROTOBUF_COMPILER_COMMAND_LINE_INTERFACE_TESTER_H__ |
||||
#define GOOGLE_PROTOBUF_COMPILER_COMMAND_LINE_INTERFACE_TESTER_H__ |
||||
|
||||
#include <fcntl.h> |
||||
#include <sys/stat.h> |
||||
#include <sys/types.h> |
||||
|
||||
#include <memory> |
||||
#include <string> |
||||
#include <utility> |
||||
#include <vector> |
||||
|
||||
#ifndef _MSC_VER |
||||
#include <unistd.h> |
||||
#endif |
||||
|
||||
#include <gtest/gtest.h> |
||||
#include "absl/strings/string_view.h" |
||||
#include "google/protobuf/compiler/code_generator.h" |
||||
#include "google/protobuf/compiler/command_line_interface.h" |
||||
|
||||
// Must be included last.
|
||||
#include "google/protobuf/port_def.inc" |
||||
|
||||
namespace google { |
||||
namespace protobuf { |
||||
namespace compiler { |
||||
|
||||
// Provide a base class for testing the protoc CLI and plugins.
|
||||
class CommandLineInterfaceTester : public testing::Test { |
||||
protected: |
||||
CommandLineInterfaceTester(); |
||||
~CommandLineInterfaceTester() override; |
||||
|
||||
// Runs the CommandLineInterface with the given command line. The
|
||||
// command is automatically split on spaces, and the string "$tmpdir"
|
||||
// is replaced with TestTempDir().
|
||||
void RunProtoc(absl::string_view command); |
||||
void RunProtocWithArgs(std::vector<std::string> args); |
||||
|
||||
// -----------------------------------------------------------------
|
||||
// Methods to set up the test (called before Run()).
|
||||
|
||||
// Returns the temporary directory created for testing.
|
||||
std::string temp_directory() { return temp_directory_; } |
||||
|
||||
void AllowPlugins(const std::string& prefix) { cli_.AllowPlugins(prefix); } |
||||
|
||||
void RegisterGenerator(const std::string& flag_name, |
||||
std::unique_ptr<CodeGenerator> generator, |
||||
const std::string& help_text) { |
||||
generators_.emplace_back(std::move(generator)); |
||||
cli_.RegisterGenerator(flag_name, generators_.back().get(), help_text); |
||||
} |
||||
|
||||
void RegisterGenerator(const std::string& flag_name, |
||||
const std::string& option_flag_name, |
||||
std::unique_ptr<CodeGenerator> generator, |
||||
const std::string& help_text) { |
||||
generators_.emplace_back(std::move(generator)); |
||||
cli_.RegisterGenerator(flag_name, option_flag_name, |
||||
generators_.back().get(), help_text); |
||||
} |
||||
|
||||
// Creates a temp file within temp_directory_ with the given name.
|
||||
// The containing directory is also created if necessary.
|
||||
void CreateTempFile(absl::string_view name, absl::string_view contents); |
||||
|
||||
// Creates a subdirectory within temp_directory_.
|
||||
void CreateTempDir(absl::string_view name); |
||||
|
||||
#ifdef PROTOBUF_OPENSOURCE |
||||
// Changes working directory to temp directory.
|
||||
void SwitchToTempDirectory() { |
||||
File::ChangeWorkingDirectory(temp_directory_); |
||||
} |
||||
#endif // !PROTOBUF_OPENSOURCE
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
// Methods to check the test results (called after Run()).
|
||||
|
||||
// Checks that no text was written to stderr during Run(), and Run()
|
||||
// returned 0.
|
||||
void ExpectNoErrors(); |
||||
|
||||
// Checks that Run() returned non-zero and the stderr output is exactly
|
||||
// the text given. expected_test may contain references to "$tmpdir",
|
||||
// which will be replaced by the temporary directory path.
|
||||
void ExpectErrorText(absl::string_view expected_text); |
||||
|
||||
// Checks that Run() returned non-zero and the stderr contains the given
|
||||
// substring.
|
||||
void ExpectErrorSubstring(absl::string_view expected_substring); |
||||
|
||||
// Checks that Run() returned zero and the stderr contains the given
|
||||
// substring.
|
||||
void ExpectWarningSubstring(absl::string_view expected_substring); |
||||
|
||||
// Checks that the captured stdout is the same as the expected_text.
|
||||
void ExpectCapturedStdout(absl::string_view expected_text); |
||||
|
||||
// Checks that Run() returned zero and the stdout contains the given
|
||||
// substring.
|
||||
void ExpectCapturedStdoutSubstringWithZeroReturnCode( |
||||
absl::string_view expected_substring); |
||||
|
||||
// Checks that Run() returned zero and the stderr contains the given
|
||||
// substring.
|
||||
void ExpectCapturedStderrSubstringWithZeroReturnCode( |
||||
absl::string_view expected_substring); |
||||
|
||||
#if defined(_WIN32) && !defined(__CYGWIN__) |
||||
// Returns true if ExpectErrorSubstring(expected_substring) would pass, but
|
||||
// does not fail otherwise.
|
||||
bool HasAlternateErrorSubstring(const std::string& expected_substring); |
||||
#endif // _WIN32 && !__CYGWIN__
|
||||
|
||||
void ExpectFileContent(absl::string_view filename, absl::string_view content); |
||||
|
||||
private: |
||||
// The object we are testing.
|
||||
CommandLineInterface cli_; |
||||
|
||||
// We create a directory within TestTempDir() in order to add extra
|
||||
// protection against accidentally deleting user files (since we recursively
|
||||
// delete this directory during the test). This is the full path of that
|
||||
// directory.
|
||||
std::string temp_directory_; |
||||
|
||||
// The result of Run().
|
||||
int return_code_; |
||||
|
||||
// The captured stderr output.
|
||||
std::string error_text_; |
||||
|
||||
// The captured stdout.
|
||||
std::string captured_stdout_; |
||||
|
||||
std::vector<std::unique_ptr<CodeGenerator>> generators_; |
||||
}; |
||||
|
||||
} // namespace compiler
|
||||
} // namespace protobuf
|
||||
} // namespace google
|
||||
|
||||
#include "google/protobuf/port_undef.inc" |
||||
|
||||
#endif // GOOGLE_PROTOBUF_COMPILER_COMMAND_LINE_INTERFACE_TEST_UTIL_H__
|
||||
Loading…
Reference in new issue