| // Copyright (c) 2013 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 <algorithm> |
| #include <sstream> |
| |
| #include "testing/gtest/include/gtest/gtest.h" |
| #include "tools/gn/file_template.h" |
| #include "tools/gn/ninja_action_target_writer.h" |
| #include "tools/gn/test_with_scope.h" |
| |
| TEST(NinjaActionTargetWriter, WriteOutputFilesForBuildLine) { |
| TestWithScope setup; |
| setup.build_settings()->SetBuildDir(SourceDir("//out/Debug/")); |
| Target target(setup.settings(), Label(SourceDir("//foo/"), "bar")); |
| |
| target.action_values().outputs().push_back( |
| SourceFile("//out/Debug/gen/a b{{source_name_part}}.h")); |
| target.action_values().outputs().push_back( |
| SourceFile("//out/Debug/gen/{{source_name_part}}.cc")); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| |
| FileTemplate output_template = writer.GetOutputTemplate(); |
| |
| SourceFile source("//foo/bar.in"); |
| std::vector<OutputFile> output_files; |
| writer.WriteOutputFilesForBuildLine(output_template, source, &output_files); |
| |
| EXPECT_EQ(" gen/a$ bbar.h gen/bar.cc", out.str()); |
| } |
| |
| TEST(NinjaActionTargetWriter, WriteArgsSubstitutions) { |
| TestWithScope setup; |
| setup.build_settings()->SetBuildDir(SourceDir("//out/Debug/")); |
| Target target(setup.settings(), Label(SourceDir("//foo/"), "bar")); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| |
| std::vector<std::string> args; |
| args.push_back("-i"); |
| args.push_back("{{source}}"); |
| args.push_back("--out=foo bar{{source_name_part}}.o"); |
| FileTemplate args_template(setup.settings(), args); |
| |
| writer.WriteArgsSubstitutions(SourceFile("//foo/b ar.in"), args_template); |
| #if defined(OS_WIN) |
| EXPECT_EQ(" source = \"../../foo/b$ ar.in\"\n" |
| " source_name_part = \"b$ ar\"\n", |
| out.str()); |
| #else |
| EXPECT_EQ(" source = ../../foo/b\\$ ar.in\n" |
| " source_name_part = b\\$ ar\n", |
| out.str()); |
| #endif |
| } |
| |
| // Makes sure that we write sources as input dependencies for actions with |
| // both sources and inputs (ACTION_FOREACH treats the sources differently). |
| TEST(NinjaActionTargetWriter, ActionWithSources) { |
| TestWithScope setup; |
| setup.build_settings()->SetBuildDir(SourceDir("//out/Debug/")); |
| Target target(setup.settings(), Label(SourceDir("//foo/"), "bar")); |
| target.set_output_type(Target::ACTION); |
| |
| target.action_values().set_script(SourceFile("//foo/script.py")); |
| |
| target.sources().push_back(SourceFile("//foo/source.txt")); |
| target.inputs().push_back(SourceFile("//foo/included.txt")); |
| |
| target.action_values().outputs().push_back( |
| SourceFile("//out/Debug/foo.out")); |
| |
| // Posix. |
| { |
| setup.settings()->set_target_os(Settings::LINUX); |
| setup.build_settings()->set_python_path(base::FilePath(FILE_PATH_LITERAL( |
| "/usr/bin/python"))); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| writer.Run(); |
| |
| const char expected_linux[] = |
| "rule __foo_bar___rule\n" |
| " command = /usr/bin/python ../../foo/script.py\n" |
| " description = ACTION //foo:bar()\n" |
| " restat = 1\n" |
| "build obj/foo/bar.inputdeps.stamp: stamp ../../foo/script.py " |
| "../../foo/included.txt ../../foo/source.txt\n" |
| "\n" |
| "build foo.out: __foo_bar___rule | obj/foo/bar.inputdeps.stamp\n" |
| "\n" |
| "build obj/foo/bar.stamp: stamp foo.out\n"; |
| EXPECT_EQ(expected_linux, out.str()); |
| } |
| |
| // Windows. |
| { |
| // Note: we use forward slashes here so that the output will be the same on |
| // Linux and Windows. |
| setup.build_settings()->set_python_path(base::FilePath(FILE_PATH_LITERAL( |
| "C:/python/python.exe"))); |
| setup.settings()->set_target_os(Settings::WIN); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| writer.Run(); |
| |
| const char expected_win[] = |
| "rule __foo_bar___rule\n" |
| " command = C$:/python/python.exe gyp-win-tool action-wrapper environment.x86 __foo_bar___rule.$unique_name.rsp\n" |
| " description = ACTION //foo:bar()\n" |
| " restat = 1\n" |
| " rspfile = __foo_bar___rule.$unique_name.rsp\n" |
| " rspfile_content = C$:/python/python.exe ../../foo/script.py\n" |
| "build obj/foo/bar.inputdeps.stamp: stamp ../../foo/script.py " |
| "../../foo/included.txt ../../foo/source.txt\n" |
| "\n" |
| "build foo.out: __foo_bar___rule | obj/foo/bar.inputdeps.stamp\n" |
| "\n" |
| "build obj/foo/bar.stamp: stamp foo.out\n"; |
| EXPECT_EQ(expected_win, out.str()); |
| } |
| } |
| |
| TEST(NinjaActionTargetWriter, ForEach) { |
| TestWithScope setup; |
| setup.build_settings()->SetBuildDir(SourceDir("//out/Debug/")); |
| |
| // Some dependencies that the action can depend on. Use actions for these |
| // so they have a nice platform-independent stamp file that can appear in the |
| // output (rather than having to worry about how the current platform names |
| // binaries). |
| Target dep(setup.settings(), Label(SourceDir("//foo/"), "dep")); |
| dep.set_output_type(Target::ACTION); |
| Target datadep(setup.settings(), Label(SourceDir("//foo/"), "datadep")); |
| datadep.set_output_type(Target::ACTION); |
| |
| Target target(setup.settings(), Label(SourceDir("//foo/"), "bar")); |
| target.set_output_type(Target::ACTION_FOREACH); |
| target.deps().push_back(LabelTargetPair(&dep)); |
| target.datadeps().push_back(LabelTargetPair(&datadep)); |
| |
| target.sources().push_back(SourceFile("//foo/input1.txt")); |
| target.sources().push_back(SourceFile("//foo/input2.txt")); |
| |
| target.action_values().set_script(SourceFile("//foo/script.py")); |
| |
| target.action_values().args().push_back("-i"); |
| target.action_values().args().push_back("{{source}}"); |
| target.action_values().args().push_back( |
| "--out=foo bar{{source_name_part}}.o"); |
| |
| target.action_values().outputs().push_back( |
| SourceFile("//out/Debug/{{source_name_part}}.out")); |
| |
| target.inputs().push_back(SourceFile("//foo/included.txt")); |
| |
| // Posix. |
| { |
| setup.settings()->set_target_os(Settings::LINUX); |
| setup.build_settings()->set_python_path(base::FilePath(FILE_PATH_LITERAL( |
| "/usr/bin/python"))); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| writer.Run(); |
| |
| const char expected_linux[] = |
| "rule __foo_bar___rule\n" |
| " command = /usr/bin/python ../../foo/script.py -i ${source} " |
| // Escaping is different between Windows and Posix. |
| #if defined(OS_WIN) |
| "\"--out=foo$ bar${source_name_part}.o\"\n" |
| #else |
| "--out=foo\\$ bar${source_name_part}.o\n" |
| #endif |
| " description = ACTION //foo:bar()\n" |
| " restat = 1\n" |
| "build obj/foo/bar.inputdeps.stamp: stamp ../../foo/script.py " |
| "../../foo/included.txt obj/foo/dep.stamp\n" |
| "\n" |
| "build input1.out: __foo_bar___rule ../../foo/input1.txt | " |
| "obj/foo/bar.inputdeps.stamp\n" |
| " source = ../../foo/input1.txt\n" |
| " source_name_part = input1\n" |
| "build input2.out: __foo_bar___rule ../../foo/input2.txt | " |
| "obj/foo/bar.inputdeps.stamp\n" |
| " source = ../../foo/input2.txt\n" |
| " source_name_part = input2\n" |
| "\n" |
| "build obj/foo/bar.stamp: " |
| "stamp input1.out input2.out obj/foo/datadep.stamp\n"; |
| |
| std::string out_str = out.str(); |
| #if defined(OS_WIN) |
| std::replace(out_str.begin(), out_str.end(), '\\', '/'); |
| #endif |
| EXPECT_EQ(expected_linux, out_str); |
| } |
| |
| // Windows. |
| { |
| setup.build_settings()->set_python_path(base::FilePath(FILE_PATH_LITERAL( |
| "C:/python/python.exe"))); |
| setup.settings()->set_target_os(Settings::WIN); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| writer.Run(); |
| |
| const char expected_win[] = |
| "rule __foo_bar___rule\n" |
| " command = C$:/python/python.exe gyp-win-tool action-wrapper " |
| "environment.x86 __foo_bar___rule.$unique_name.rsp\n" |
| " description = ACTION //foo:bar()\n" |
| " restat = 1\n" |
| " rspfile = __foo_bar___rule.$unique_name.rsp\n" |
| " rspfile_content = C$:/python/python.exe ../../foo/script.py -i " |
| #if defined(OS_WIN) |
| "${source} \"--out=foo$ bar${source_name_part}.o\"\n" |
| #else |
| "${source} --out=foo\\$ bar${source_name_part}.o\n" |
| #endif |
| "build obj/foo/bar.inputdeps.stamp: stamp ../../foo/script.py " |
| "../../foo/included.txt obj/foo/dep.stamp\n" |
| "\n" |
| "build input1.out: __foo_bar___rule ../../foo/input1.txt | " |
| "obj/foo/bar.inputdeps.stamp\n" |
| " unique_name = 0\n" |
| " source = ../../foo/input1.txt\n" |
| " source_name_part = input1\n" |
| "build input2.out: __foo_bar___rule ../../foo/input2.txt | " |
| "obj/foo/bar.inputdeps.stamp\n" |
| " unique_name = 1\n" |
| " source = ../../foo/input2.txt\n" |
| " source_name_part = input2\n" |
| "\n" |
| "build obj/foo/bar.stamp: " |
| "stamp input1.out input2.out obj/foo/datadep.stamp\n"; |
| EXPECT_EQ(expected_win, out.str()); |
| } |
| } |
| |
| TEST(NinjaActionTargetWriter, ForEachWithDepfile) { |
| TestWithScope setup; |
| setup.build_settings()->SetBuildDir(SourceDir("//out/Debug/")); |
| Target target(setup.settings(), Label(SourceDir("//foo/"), "bar")); |
| target.set_output_type(Target::ACTION_FOREACH); |
| |
| target.sources().push_back(SourceFile("//foo/input1.txt")); |
| target.sources().push_back(SourceFile("//foo/input2.txt")); |
| |
| target.action_values().set_script(SourceFile("//foo/script.py")); |
| target.action_values().set_depfile( |
| SourceFile("//out/Debug/gen/{{source_name_part}}.d")); |
| |
| target.action_values().args().push_back("-i"); |
| target.action_values().args().push_back("{{source}}"); |
| target.action_values().args().push_back( |
| "--out=foo bar{{source_name_part}}.o"); |
| |
| target.action_values().outputs().push_back( |
| SourceFile("//out/Debug/{{source_name_part}}.out")); |
| |
| target.inputs().push_back(SourceFile("//foo/included.txt")); |
| |
| // Posix. |
| { |
| setup.settings()->set_target_os(Settings::LINUX); |
| setup.build_settings()->set_python_path(base::FilePath(FILE_PATH_LITERAL( |
| "/usr/bin/python"))); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| writer.Run(); |
| |
| const char expected_linux[] = |
| "rule __foo_bar___rule\n" |
| " command = /usr/bin/python ../../foo/script.py -i ${source} " |
| #if defined(OS_WIN) |
| "\"--out=foo$ bar${source_name_part}.o\"\n" |
| #else |
| "--out=foo\\$ bar${source_name_part}.o\n" |
| #endif |
| " description = ACTION //foo:bar()\n" |
| " restat = 1\n" |
| "build obj/foo/bar.inputdeps.stamp: stamp ../../foo/script.py " |
| "../../foo/included.txt\n" |
| "\n" |
| "build input1.out: __foo_bar___rule ../../foo/input1.txt" |
| " | obj/foo/bar.inputdeps.stamp\n" |
| " source = ../../foo/input1.txt\n" |
| " source_name_part = input1\n" |
| " depfile = gen/input1.d\n" |
| "build input2.out: __foo_bar___rule ../../foo/input2.txt" |
| " | obj/foo/bar.inputdeps.stamp\n" |
| " source = ../../foo/input2.txt\n" |
| " source_name_part = input2\n" |
| " depfile = gen/input2.d\n" |
| "\n" |
| "build obj/foo/bar.stamp: stamp input1.out input2.out\n"; |
| EXPECT_EQ(expected_linux, out.str()); |
| } |
| |
| // Windows. |
| { |
| setup.build_settings()->set_python_path(base::FilePath(FILE_PATH_LITERAL( |
| "C:/python/python.exe"))); |
| setup.settings()->set_target_os(Settings::WIN); |
| |
| std::ostringstream out; |
| NinjaActionTargetWriter writer(&target, setup.toolchain(), out); |
| writer.Run(); |
| |
| const char expected_win[] = |
| "rule __foo_bar___rule\n" |
| " command = C$:/python/python.exe gyp-win-tool action-wrapper " |
| "environment.x86 __foo_bar___rule.$unique_name.rsp\n" |
| " description = ACTION //foo:bar()\n" |
| " restat = 1\n" |
| " rspfile = __foo_bar___rule.$unique_name.rsp\n" |
| " rspfile_content = C$:/python/python.exe ../../foo/script.py -i " |
| #if defined(OS_WIN) |
| "${source} \"--out=foo$ bar${source_name_part}.o\"\n" |
| #else |
| "${source} --out=foo\\$ bar${source_name_part}.o\n" |
| #endif |
| "build obj/foo/bar.inputdeps.stamp: stamp ../../foo/script.py " |
| "../../foo/included.txt\n" |
| "\n" |
| "build input1.out: __foo_bar___rule ../../foo/input1.txt" |
| " | obj/foo/bar.inputdeps.stamp\n" |
| " unique_name = 0\n" |
| " source = ../../foo/input1.txt\n" |
| " source_name_part = input1\n" |
| " depfile = gen/input1.d\n" |
| "build input2.out: __foo_bar___rule ../../foo/input2.txt" |
| " | obj/foo/bar.inputdeps.stamp\n" |
| " unique_name = 1\n" |
| " source = ../../foo/input2.txt\n" |
| " source_name_part = input2\n" |
| " depfile = gen/input2.d\n" |
| "\n" |
| "build obj/foo/bar.stamp: stamp input1.out input2.out\n"; |
| EXPECT_EQ(expected_win, out.str()); |
| } |
| } |