blob: f8abaf2a87eae89ccb814b871630a72e412c417e [file] [log] [blame]
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <fstream>
#include <sstream>
#include "base/command_line.h"
#include "base/files/file_util.h"
#include "gn/ninja_build_writer.h"
#include "gn/pool.h"
#include "gn/scheduler.h"
#include "gn/switches.h"
#include "gn/target.h"
#include "gn/test_with_scheduler.h"
#include "gn/test_with_scope.h"
#include "util/test/test.h"
using NinjaBuildWriterTest = TestWithScheduler;
class ScopedDotGNFile {
public:
ScopedDotGNFile(const base::FilePath& path)
: path_(path),
file_(path, base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE) {
EXPECT_TRUE(file_.IsValid());
}
~ScopedDotGNFile() {
file_.Close();
base::DeleteFile(path_, false);
}
private:
base::FilePath path_;
base::File file_;
};
TEST_F(NinjaBuildWriterTest, GetSelfInvocationCommandLine) {
// TestWithScope sets up a config with a build dir of //out/Debug.
TestWithScope setup;
base::CommandLine cmd_out(base::CommandLine::NO_PROGRAM);
// Setup sets the default root dir to ".".
base::FilePath root(FILE_PATH_LITERAL("."));
base::FilePath root_realpath = base::MakeAbsoluteFilePath(root);
base::FilePath gn(FILE_PATH_LITERAL("testdot.gn"));
// The file must exist on disk for MakeAbsoluteFilePath() to work.
ScopedDotGNFile dot_gn(gn);
base::FilePath gn_realpath = base::MakeAbsoluteFilePath(gn);
// Without any parameters the self invocation should pass --root=../..
// (from //out/Debug to //).
setup.build_settings()->SetRootPath(root_realpath);
cmd_out = GetSelfInvocationCommandLine(setup.build_settings());
EXPECT_EQ("../..", cmd_out.GetSwitchValueASCII(switches::kRoot));
EXPECT_FALSE(cmd_out.HasSwitch(switches::kDotfile));
// If --root is . and --dotfile is foo/.gn, then --dotfile also needs
// to to become ../../foo/.gn.
setup.build_settings()->SetRootPath(root_realpath);
setup.build_settings()->set_dotfile_name(gn_realpath);
cmd_out = GetSelfInvocationCommandLine(setup.build_settings());
EXPECT_EQ("../..", cmd_out.GetSwitchValueASCII(switches::kRoot));
EXPECT_EQ("../../testdot.gn",
cmd_out.GetSwitchValueASCII(switches::kDotfile));
}
TEST_F(NinjaBuildWriterTest, TwoTargets) {
TestWithScope setup;
Err err;
Target target_foo(setup.settings(), Label(SourceDir("//foo/"), "bar"));
target_foo.set_output_type(Target::ACTION);
target_foo.action_values().set_script(SourceFile("//foo/script.py"));
target_foo.action_values().outputs() = SubstitutionList::MakeForTest(
"//out/Debug/out1.out", "//out/Debug/out2.out");
target_foo.SetToolchain(setup.toolchain());
ASSERT_TRUE(target_foo.OnResolved(&err));
Target target_bar(setup.settings(), Label(SourceDir("//bar/"), "bar"));
target_bar.set_output_type(Target::ACTION);
target_bar.action_values().set_script(SourceFile("//bar/script.py"));
target_bar.action_values().outputs() = SubstitutionList::MakeForTest(
"//out/Debug/out3.out", "//out/Debug/out4.out");
target_bar.SetToolchain(setup.toolchain());
ASSERT_TRUE(target_bar.OnResolved(&err));
// Make a secondary toolchain that references two pools.
Label other_toolchain_label(SourceDir("//other/"), "toolchain");
Toolchain other_toolchain(setup.settings(), other_toolchain_label);
TestWithScope::SetupToolchain(&other_toolchain);
Pool other_regular_pool(
setup.settings(),
Label(SourceDir("//other/"), "depth_pool", other_toolchain_label.dir(),
other_toolchain_label.name()));
other_regular_pool.set_depth(42);
other_toolchain.GetTool(CTool::kCToolLink)
->set_pool(LabelPtrPair<Pool>(&other_regular_pool));
// Make another target that uses its own pool
Pool another_regular_pool(
setup.settings(),
Label(SourceDir("//another/"), "depth_pool", other_toolchain_label.dir(),
other_toolchain_label.name()));
another_regular_pool.set_depth(7);
Target target_baz(setup.settings(), Label(SourceDir("//baz/"), "baz"));
target_baz.set_output_type(Target::ACTION);
target_baz.action_values().set_script(SourceFile("//baz/script.py"));
target_baz.action_values().outputs() = SubstitutionList::MakeForTest(
"//out/Debug/out5.out", "//out/Debug/out6.out");
target_baz.SetToolchain(&other_toolchain);
target_baz.action_values().set_pool(
LabelPtrPair<Pool>(&another_regular_pool));
ASSERT_TRUE(target_baz.OnResolved(&err));
// The console pool must be in the default toolchain.
Pool console_pool(setup.settings(), Label(SourceDir("//"), "console",
setup.toolchain()->label().dir(),
setup.toolchain()->label().name()));
console_pool.set_depth(1);
other_toolchain.GetTool(GeneralTool::kGeneralToolStamp)
->set_pool(LabelPtrPair<Pool>(&console_pool));
// Settings to go with the other toolchain.
Settings other_settings(setup.build_settings(), "toolchain/");
other_settings.set_toolchain_label(other_toolchain_label);
std::unordered_map<const Settings*, const Toolchain*> used_toolchains;
used_toolchains[setup.settings()] = setup.toolchain();
used_toolchains[&other_settings] = &other_toolchain;
std::vector<const Target*> targets = {&target_foo, &target_bar, &target_baz};
std::ostringstream ninja_out;
std::ostringstream depfile_out;
NinjaBuildWriter writer(setup.build_settings(), used_toolchains, targets,
setup.toolchain(), targets, ninja_out, depfile_out);
ASSERT_TRUE(writer.Run(&err));
const char expected_rule_gn[] = "rule gn\n";
const char expected_build_ninja_stamp[] =
"build build.ninja.stamp: gn\n"
" generator = 1\n"
" depfile = build.ninja.d\n";
const char expected_build_ninja[] =
"build build.ninja: phony build.ninja.stamp\n"
" generator = 1\n";
const char expected_other_pool[] =
"pool other_toolchain_another_depth_pool\n"
" depth = 7\n"
"\n"
"pool other_toolchain_other_depth_pool\n"
" depth = 42\n";
const char expected_toolchain[] = "subninja toolchain.ninja\n";
const char expected_targets[] =
"build bar: phony obj/bar/bar.stamp\n"
"build baz: phony obj/baz/baz.stamp\n"
"build foo$:bar: phony obj/foo/bar.stamp\n"
"build bar$:bar: phony obj/bar/bar.stamp\n"
"build baz$:baz: phony obj/baz/baz.stamp\n";
const char expected_root_target[] =
"build all: phony $\n"
" obj/foo/bar.stamp $\n"
" obj/bar/bar.stamp $\n"
" obj/baz/baz.stamp\n";
const char expected_default[] = "default all\n";
std::string out_str = ninja_out.str();
#define EXPECT_SNIPPET(expected) \
EXPECT_NE(std::string::npos, out_str.find(expected)) \
<< "Expected to find: " << expected << "\n" \
<< "Within: " << out_str
EXPECT_SNIPPET(expected_rule_gn);
EXPECT_SNIPPET(expected_build_ninja_stamp);
EXPECT_SNIPPET(expected_build_ninja);
EXPECT_SNIPPET(expected_other_pool);
EXPECT_SNIPPET(expected_toolchain);
EXPECT_SNIPPET(expected_targets);
EXPECT_SNIPPET(expected_root_target);
EXPECT_SNIPPET(expected_default);
#undef EXPECT_SNIPPET
// A pool definition for ninja's built-in console pool must not be written.
EXPECT_EQ(std::string::npos, out_str.find("pool console"));
}
TEST_F(NinjaBuildWriterTest, ExtractRegenerationCommands) {
TestWithScope setup;
Err err;
Target target_foo(setup.settings(), Label(SourceDir("//foo/"), "bar"));
target_foo.set_output_type(Target::ACTION);
target_foo.action_values().set_script(SourceFile("//foo/script.py"));
target_foo.action_values().outputs() = SubstitutionList::MakeForTest(
"//out/Debug/out1.out", "//out/Debug/out2.out");
target_foo.SetToolchain(setup.toolchain());
ASSERT_TRUE(target_foo.OnResolved(&err));
// The console pool must be in the default toolchain.
Pool console_pool(setup.settings(), Label(SourceDir("//"), "console",
setup.toolchain()->label().dir(),
setup.toolchain()->label().name()));
console_pool.set_depth(1);
std::unordered_map<const Settings*, const Toolchain*> used_toolchains;
used_toolchains[setup.settings()] = setup.toolchain();
std::vector<const Target*> targets = {&target_foo};
std::stringstream ninja_out;
std::ostringstream depfile_out;
NinjaBuildWriter writer(setup.build_settings(), used_toolchains, targets,
setup.toolchain(), targets, ninja_out, depfile_out);
ASSERT_TRUE(writer.Run(&err));
const char expected_rule_gn[] = "rule gn\n";
const char expected_build_ninja_stamp[] = "build build.ninja.stamp: gn\n";
const char expected_build_ninja[] =
"build build.ninja: phony build.ninja.stamp\n";
const char expected_target[] = "build bar:";
const char expected_root_target[] = "build all: phony $\n";
const char expected_default[] = "default all\n";
std::string ninja_out_str = ninja_out.str();
#define EXPECT_SNIPPET(str, expected) \
EXPECT_NE(std::string::npos, str.find(expected)) \
<< "Expected to find: " << expected << "\n" \
<< "Within: " << str
#define EXPECT_NO_SNIPPET(str, unexpected) \
EXPECT_EQ(std::string::npos, str.find(unexpected)) \
<< "Found unexpected: " << unexpected << "\n" \
<< "Within: " << str
EXPECT_SNIPPET(ninja_out_str, expected_rule_gn);
EXPECT_SNIPPET(ninja_out_str, expected_build_ninja_stamp);
EXPECT_SNIPPET(ninja_out_str, expected_build_ninja);
EXPECT_SNIPPET(ninja_out_str, expected_target);
EXPECT_SNIPPET(ninja_out_str, expected_root_target);
EXPECT_SNIPPET(ninja_out_str, expected_default);
std::string commands =
NinjaBuildWriter::ExtractRegenerationCommands(ninja_out);
EXPECT_SNIPPET(commands, expected_rule_gn);
EXPECT_SNIPPET(commands, expected_build_ninja_stamp);
EXPECT_SNIPPET(commands, expected_build_ninja);
EXPECT_NO_SNIPPET(commands, expected_target);
EXPECT_NO_SNIPPET(commands, expected_root_target);
EXPECT_NO_SNIPPET(commands, expected_default);
#undef EXPECT_SNIPPET
#undef EXPECT_NO_SNIPPET
}
TEST_F(NinjaBuildWriterTest, ExtractRegenerationCommands_DefaultStream) {
std::ifstream ninja_in;
EXPECT_EQ(NinjaBuildWriter::ExtractRegenerationCommands(ninja_in), "");
}
TEST_F(NinjaBuildWriterTest, ExtractRegenerationCommands_StreamError) {
std::ifstream ninja_in("/does/not/exist");
EXPECT_EQ(NinjaBuildWriter::ExtractRegenerationCommands(ninja_in), "");
}
TEST_F(NinjaBuildWriterTest, ExtractRegenerationCommands_IncompleteNinja) {
std::stringstream ninja_in;
ninja_in << "foo\nbar\nbaz\nbif\n";
EXPECT_EQ(NinjaBuildWriter::ExtractRegenerationCommands(ninja_in), "");
}
TEST_F(NinjaBuildWriterTest, SpaceInDepfile) {
TestWithScope setup;
Err err;
// Setup sets the default root dir to ".".
base::FilePath root(FILE_PATH_LITERAL("."));
base::FilePath root_realpath = base::MakeAbsoluteFilePath(root);
setup.build_settings()->SetRootPath(root_realpath);
// Cannot use MakeAbsoluteFilePath for non-existed paths
base::FilePath dependency =
root_realpath.Append(FILE_PATH_LITERAL("path with space/BUILD.gn"));
g_scheduler->AddGenDependency(dependency);
std::unordered_map<const Settings*, const Toolchain*> used_toolchains;
used_toolchains[setup.settings()] = setup.toolchain();
std::vector<const Target*> targets;
std::ostringstream ninja_out;
std::ostringstream depfile_out;
NinjaBuildWriter writer(setup.build_settings(), used_toolchains, targets,
setup.toolchain(), targets, ninja_out, depfile_out);
ASSERT_TRUE(writer.Run(&err));
EXPECT_EQ(depfile_out.str(),
"build.ninja.stamp: ../../path\\ with\\ space/BUILD.gn");
}
TEST_F(NinjaBuildWriterTest, DuplicateOutputs) {
TestWithScope setup;
Err err;
Target target_foo(setup.settings(), Label(SourceDir("//foo/"), "bar"));
target_foo.set_output_type(Target::ACTION);
target_foo.action_values().set_script(SourceFile("//foo/script.py"));
target_foo.action_values().outputs() = SubstitutionList::MakeForTest(
"//out/Debug/out1.out", "//out/Debug/out2.out");
target_foo.SetToolchain(setup.toolchain());
ASSERT_TRUE(target_foo.OnResolved(&err));
Target target_bar(setup.settings(), Label(SourceDir("//bar/"), "bar"));
target_bar.set_output_type(Target::ACTION);
target_bar.action_values().set_script(SourceFile("//bar/script.py"));
target_bar.action_values().outputs() = SubstitutionList::MakeForTest(
"//out/Debug/out3.out", "//out/Debug/out2.out");
target_bar.SetToolchain(setup.toolchain());
ASSERT_TRUE(target_bar.OnResolved(&err));
std::unordered_map<const Settings*, const Toolchain*> used_toolchains;
used_toolchains[setup.settings()] = setup.toolchain();
std::vector<const Target*> targets = {&target_foo, &target_bar};
std::ostringstream ninja_out;
std::ostringstream depfile_out;
NinjaBuildWriter writer(setup.build_settings(), used_toolchains, targets,
setup.toolchain(), targets, ninja_out, depfile_out);
ASSERT_FALSE(writer.Run(&err));
const char expected_help_test[] =
"Two or more targets generate the same output:\n"
" out2.out\n"
"\n"
"This is can often be fixed by changing one of the target names, or by \n"
"setting an output_name on one of them.\n"
"\n"
"Collisions:\n"
" //foo:bar()\n"
" //bar:bar()\n";
EXPECT_EQ(expected_help_test, err.help_text());
}