1 // Copyright 2011 Google Inc. All Rights Reserved.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
17 #include "build_log.h"
21 /// Fixture for tests involving Plan.
22 // Though Plan doesn't use State, it's useful to have one around
23 // to create Nodes and Edges.
24 struct PlanTest : public StateTestWithBuiltinRules {
28 TEST_F(PlanTest, Basic) {
30 "build out: cat mid\n"
31 "build mid: cat in\n");
32 GetNode("mid")->MarkDirty();
33 GetNode("out")->MarkDirty();
35 EXPECT_TRUE(plan_.AddTarget(GetNode("out"), &err));
37 ASSERT_TRUE(plan_.more_to_do());
39 Edge* edge = plan_.FindWork();
41 ASSERT_EQ("in", edge->inputs_[0]->path());
42 ASSERT_EQ("mid", edge->outputs_[0]->path());
44 ASSERT_FALSE(plan_.FindWork());
46 plan_.EdgeFinished(edge);
48 edge = plan_.FindWork();
50 ASSERT_EQ("mid", edge->inputs_[0]->path());
51 ASSERT_EQ("out", edge->outputs_[0]->path());
53 plan_.EdgeFinished(edge);
55 ASSERT_FALSE(plan_.more_to_do());
56 edge = plan_.FindWork();
60 // Test that two outputs from one rule can be handled as inputs to the next.
61 TEST_F(PlanTest, DoubleOutputDirect) {
63 "build out: cat mid1 mid2\n"
64 "build mid1 mid2: cat in\n");
65 GetNode("mid1")->MarkDirty();
66 GetNode("mid2")->MarkDirty();
67 GetNode("out")->MarkDirty();
70 EXPECT_TRUE(plan_.AddTarget(GetNode("out"), &err));
72 ASSERT_TRUE(plan_.more_to_do());
75 edge = plan_.FindWork();
76 ASSERT_TRUE(edge); // cat in
77 plan_.EdgeFinished(edge);
79 edge = plan_.FindWork();
80 ASSERT_TRUE(edge); // cat mid1 mid2
81 plan_.EdgeFinished(edge);
83 edge = plan_.FindWork();
84 ASSERT_FALSE(edge); // done
87 // Test that two outputs from one rule can eventually be routed to another.
88 TEST_F(PlanTest, DoubleOutputIndirect) {
90 "build out: cat b1 b2\n"
93 "build a1 a2: cat in\n");
94 GetNode("a1")->MarkDirty();
95 GetNode("a2")->MarkDirty();
96 GetNode("b1")->MarkDirty();
97 GetNode("b2")->MarkDirty();
98 GetNode("out")->MarkDirty();
100 EXPECT_TRUE(plan_.AddTarget(GetNode("out"), &err));
102 ASSERT_TRUE(plan_.more_to_do());
105 edge = plan_.FindWork();
106 ASSERT_TRUE(edge); // cat in
107 plan_.EdgeFinished(edge);
109 edge = plan_.FindWork();
110 ASSERT_TRUE(edge); // cat a1
111 plan_.EdgeFinished(edge);
113 edge = plan_.FindWork();
114 ASSERT_TRUE(edge); // cat a2
115 plan_.EdgeFinished(edge);
117 edge = plan_.FindWork();
118 ASSERT_TRUE(edge); // cat b1 b2
119 plan_.EdgeFinished(edge);
121 edge = plan_.FindWork();
122 ASSERT_FALSE(edge); // done
125 // Test that two edges from one output can both execute.
126 TEST_F(PlanTest, DoubleDependent) {
128 "build out: cat a1 a2\n"
129 "build a1: cat mid\n"
130 "build a2: cat mid\n"
131 "build mid: cat in\n");
132 GetNode("mid")->MarkDirty();
133 GetNode("a1")->MarkDirty();
134 GetNode("a2")->MarkDirty();
135 GetNode("out")->MarkDirty();
138 EXPECT_TRUE(plan_.AddTarget(GetNode("out"), &err));
140 ASSERT_TRUE(plan_.more_to_do());
143 edge = plan_.FindWork();
144 ASSERT_TRUE(edge); // cat in
145 plan_.EdgeFinished(edge);
147 edge = plan_.FindWork();
148 ASSERT_TRUE(edge); // cat mid
149 plan_.EdgeFinished(edge);
151 edge = plan_.FindWork();
152 ASSERT_TRUE(edge); // cat mid
153 plan_.EdgeFinished(edge);
155 edge = plan_.FindWork();
156 ASSERT_TRUE(edge); // cat a1 a2
157 plan_.EdgeFinished(edge);
159 edge = plan_.FindWork();
160 ASSERT_FALSE(edge); // done
163 TEST_F(PlanTest, DependencyCycle) {
165 "build out: cat mid\n"
166 "build mid: cat in\n"
167 "build in: cat pre\n"
168 "build pre: cat out\n");
169 GetNode("out")->MarkDirty();
170 GetNode("mid")->MarkDirty();
171 GetNode("in")->MarkDirty();
172 GetNode("pre")->MarkDirty();
175 EXPECT_FALSE(plan_.AddTarget(GetNode("out"), &err));
176 ASSERT_EQ("dependency cycle: out -> mid -> in -> pre -> out", err);
179 TEST_F(PlanTest, PoolWithDepthOne) {
180 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
184 " command = cat $in > $out\n"
186 "build out1: poolcat in\n"
187 "build out2: poolcat in\n"));
188 GetNode("out1")->MarkDirty();
189 GetNode("out2")->MarkDirty();
191 EXPECT_TRUE(plan_.AddTarget(GetNode("out1"), &err));
193 EXPECT_TRUE(plan_.AddTarget(GetNode("out2"), &err));
195 ASSERT_TRUE(plan_.more_to_do());
197 Edge* edge = plan_.FindWork();
199 ASSERT_EQ("in", edge->inputs_[0]->path());
200 ASSERT_EQ("out1", edge->outputs_[0]->path());
202 // This will be false since poolcat is serialized
203 ASSERT_FALSE(plan_.FindWork());
205 plan_.EdgeFinished(edge);
207 edge = plan_.FindWork();
209 ASSERT_EQ("in", edge->inputs_[0]->path());
210 ASSERT_EQ("out2", edge->outputs_[0]->path());
212 ASSERT_FALSE(plan_.FindWork());
214 plan_.EdgeFinished(edge);
216 ASSERT_FALSE(plan_.more_to_do());
217 edge = plan_.FindWork();
221 TEST_F(PlanTest, PoolsWithDepthTwo) {
222 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
228 " command = cat $in > $out\n"
231 " command = cat $in > $out\n"
233 "build out1: foocat in\n"
234 "build out2: foocat in\n"
235 "build out3: foocat in\n"
236 "build outb1: bazcat in\n"
237 "build outb2: bazcat in\n"
238 "build outb3: bazcat in\n"
240 "build allTheThings: cat out1 out2 out3 outb1 outb2 outb3\n"
242 // Mark all the out* nodes dirty
243 for (int i = 0; i < 3; ++i) {
244 GetNode("out" + string(1, '1' + i))->MarkDirty();
245 GetNode("outb" + string(1, '1' + i))->MarkDirty();
247 GetNode("allTheThings")->MarkDirty();
250 EXPECT_TRUE(plan_.AddTarget(GetNode("allTheThings"), &err));
253 // Grab the first 4 edges, out1 out2 outb1 outb2
255 for (int i = 0; i < 4; ++i) {
256 ASSERT_TRUE(plan_.more_to_do());
257 Edge* edge = plan_.FindWork();
259 ASSERT_EQ("in", edge->inputs_[0]->path());
260 string base_name(i < 2 ? "out" : "outb");
261 ASSERT_EQ(base_name + string(1, '1' + (i % 2)), edge->outputs_[0]->path());
262 edges.push_back(edge);
265 // outb3 is exempt because it has an empty pool
266 ASSERT_TRUE(plan_.more_to_do());
267 Edge* edge = plan_.FindWork();
269 ASSERT_EQ("in", edge->inputs_[0]->path());
270 ASSERT_EQ("outb3", edge->outputs_[0]->path());
271 edges.push_back(edge);
273 ASSERT_FALSE(plan_.FindWork());
276 plan_.EdgeFinished(edges.front());
279 // out3 should be available
280 Edge* out3 = plan_.FindWork();
282 ASSERT_EQ("in", out3->inputs_[0]->path());
283 ASSERT_EQ("out3", out3->outputs_[0]->path());
285 ASSERT_FALSE(plan_.FindWork());
287 plan_.EdgeFinished(out3);
289 ASSERT_FALSE(plan_.FindWork());
291 for (deque<Edge*>::iterator it = edges.begin(); it != edges.end(); ++it) {
292 plan_.EdgeFinished(*it);
295 Edge* final = plan_.FindWork();
297 ASSERT_EQ("allTheThings", final->outputs_[0]->path());
299 plan_.EdgeFinished(final);
301 ASSERT_FALSE(plan_.more_to_do());
302 ASSERT_FALSE(plan_.FindWork());
305 TEST_F(PlanTest, PoolWithRedundantEdges) {
306 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
310 " command = touch foo.cpp\n"
312 " command = touch bar.cpp\n"
314 " command = echo $out > $out\n"
315 "build foo.cpp.obj: echo foo.cpp || foo.cpp\n"
317 "build bar.cpp.obj: echo bar.cpp || bar.cpp\n"
319 "build libfoo.a: echo foo.cpp.obj bar.cpp.obj\n"
320 "build foo.cpp: gen_foo\n"
321 "build bar.cpp: gen_bar\n"
322 "build all: phony libfoo.a\n"));
323 GetNode("foo.cpp")->MarkDirty();
324 GetNode("foo.cpp.obj")->MarkDirty();
325 GetNode("bar.cpp")->MarkDirty();
326 GetNode("bar.cpp.obj")->MarkDirty();
327 GetNode("libfoo.a")->MarkDirty();
328 GetNode("all")->MarkDirty();
330 EXPECT_TRUE(plan_.AddTarget(GetNode("all"), &err));
332 ASSERT_TRUE(plan_.more_to_do());
336 edge = plan_.FindWork();
338 ASSERT_EQ("foo.cpp", edge->outputs_[0]->path());
339 plan_.EdgeFinished(edge);
341 edge = plan_.FindWork();
343 ASSERT_EQ("foo.cpp", edge->inputs_[0]->path());
344 ASSERT_EQ("foo.cpp", edge->inputs_[1]->path());
345 ASSERT_EQ("foo.cpp.obj", edge->outputs_[0]->path());
346 plan_.EdgeFinished(edge);
348 edge = plan_.FindWork();
350 ASSERT_EQ("bar.cpp", edge->outputs_[0]->path());
351 plan_.EdgeFinished(edge);
353 edge = plan_.FindWork();
355 ASSERT_EQ("bar.cpp", edge->inputs_[0]->path());
356 ASSERT_EQ("bar.cpp", edge->inputs_[1]->path());
357 ASSERT_EQ("bar.cpp.obj", edge->outputs_[0]->path());
358 plan_.EdgeFinished(edge);
360 edge = plan_.FindWork();
362 ASSERT_EQ("foo.cpp.obj", edge->inputs_[0]->path());
363 ASSERT_EQ("bar.cpp.obj", edge->inputs_[1]->path());
364 ASSERT_EQ("libfoo.a", edge->outputs_[0]->path());
365 plan_.EdgeFinished(edge);
367 edge = plan_.FindWork();
369 ASSERT_EQ("libfoo.a", edge->inputs_[0]->path());
370 ASSERT_EQ("all", edge->outputs_[0]->path());
371 plan_.EdgeFinished(edge);
373 edge = plan_.FindWork();
375 ASSERT_FALSE(plan_.more_to_do());
378 /// Fake implementation of CommandRunner, useful for tests.
379 struct FakeCommandRunner : public CommandRunner {
380 explicit FakeCommandRunner(VirtualFileSystem* fs) :
381 last_command_(NULL), fs_(fs) {}
383 // CommandRunner impl
384 virtual bool CanRunMore();
385 virtual bool StartCommand(Edge* edge);
386 virtual bool WaitForCommand(Result* result);
387 virtual vector<Edge*> GetActiveEdges();
388 virtual void Abort();
390 vector<string> commands_ran_;
392 VirtualFileSystem* fs_;
395 struct BuildTest : public StateTestWithBuiltinRules {
396 BuildTest() : config_(MakeConfig()), command_runner_(&fs_),
397 builder_(&state_, config_, NULL, NULL, &fs_),
399 builder_.command_runner_.reset(&command_runner_);
401 "build cat1: cat in1\n"
402 "build cat2: cat in1 in2\n"
403 "build cat12: cat cat1 cat2\n");
405 fs_.Create("in1", "");
406 fs_.Create("in2", "");
410 builder_.command_runner_.release();
413 // Mark a path dirty.
414 void Dirty(const string& path);
416 BuildConfig MakeConfig() {
418 config.verbosity = BuildConfig::QUIET;
423 FakeCommandRunner command_runner_;
424 VirtualFileSystem fs_;
430 bool FakeCommandRunner::CanRunMore() {
431 // Only run one at a time.
432 return last_command_ == NULL;
435 bool FakeCommandRunner::StartCommand(Edge* edge) {
436 assert(!last_command_);
437 commands_ran_.push_back(edge->EvaluateCommand());
438 if (edge->rule().name() == "cat" ||
439 edge->rule().name() == "cat_rsp" ||
440 edge->rule().name() == "cc" ||
441 edge->rule().name() == "touch" ||
442 edge->rule().name() == "touch-interrupt") {
443 for (vector<Node*>::iterator out = edge->outputs_.begin();
444 out != edge->outputs_.end(); ++out) {
445 fs_->Create((*out)->path(), "");
447 } else if (edge->rule().name() == "true" ||
448 edge->rule().name() == "fail" ||
449 edge->rule().name() == "interrupt") {
450 // Don't do anything.
452 printf("unknown command\n");
456 last_command_ = edge;
460 bool FakeCommandRunner::WaitForCommand(Result* result) {
464 Edge* edge = last_command_;
467 if (edge->rule().name() == "interrupt" ||
468 edge->rule().name() == "touch-interrupt") {
469 result->status = ExitInterrupted;
473 if (edge->rule().name() == "fail")
474 result->status = ExitFailure;
476 result->status = ExitSuccess;
477 last_command_ = NULL;
481 vector<Edge*> FakeCommandRunner::GetActiveEdges() {
484 edges.push_back(last_command_);
488 void FakeCommandRunner::Abort() {
489 last_command_ = NULL;
492 void BuildTest::Dirty(const string& path) {
493 Node* node = GetNode(path);
496 // If it's an input file, mark that we've already stat()ed it and
498 if (!node->in_edge())
502 TEST_F(BuildTest, NoWork) {
504 EXPECT_TRUE(builder_.AlreadyUpToDate());
507 TEST_F(BuildTest, OneStep) {
508 // Given a dirty target with one ready input,
509 // we should rebuild the target.
512 EXPECT_TRUE(builder_.AddTarget("cat1", &err));
514 EXPECT_TRUE(builder_.Build(&err));
517 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
518 EXPECT_EQ("cat in1 > cat1", command_runner_.commands_ran_[0]);
521 TEST_F(BuildTest, OneStep2) {
522 // Given a target with one dirty input,
523 // we should rebuild the target.
526 EXPECT_TRUE(builder_.AddTarget("cat1", &err));
528 EXPECT_TRUE(builder_.Build(&err));
531 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
532 EXPECT_EQ("cat in1 > cat1", command_runner_.commands_ran_[0]);
535 TEST_F(BuildTest, TwoStep) {
537 EXPECT_TRUE(builder_.AddTarget("cat12", &err));
539 EXPECT_TRUE(builder_.Build(&err));
541 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
542 // Depending on how the pointers work out, we could've ran
543 // the first two commands in either order.
544 EXPECT_TRUE((command_runner_.commands_ran_[0] == "cat in1 > cat1" &&
545 command_runner_.commands_ran_[1] == "cat in1 in2 > cat2") ||
546 (command_runner_.commands_ran_[1] == "cat in1 > cat1" &&
547 command_runner_.commands_ran_[0] == "cat in1 in2 > cat2"));
549 EXPECT_EQ("cat cat1 cat2 > cat12", command_runner_.commands_ran_[2]);
553 // Modifying in2 requires rebuilding one intermediate file
554 // and the final file.
555 fs_.Create("in2", "");
557 EXPECT_TRUE(builder_.AddTarget("cat12", &err));
559 EXPECT_TRUE(builder_.Build(&err));
561 ASSERT_EQ(5u, command_runner_.commands_ran_.size());
562 EXPECT_EQ("cat in1 in2 > cat2", command_runner_.commands_ran_[3]);
563 EXPECT_EQ("cat cat1 cat2 > cat12", command_runner_.commands_ran_[4]);
566 TEST_F(BuildTest, TwoOutputs) {
567 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
569 " command = touch $out\n"
570 "build out1 out2: touch in.txt\n"));
572 fs_.Create("in.txt", "");
575 EXPECT_TRUE(builder_.AddTarget("out1", &err));
577 EXPECT_TRUE(builder_.Build(&err));
579 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
580 EXPECT_EQ("touch out1 out2", command_runner_.commands_ran_[0]);
584 // https://github.com/martine/ninja/issues/148
585 TEST_F(BuildTest, MultiOutIn) {
586 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
588 " command = touch $out\n"
589 "build in1 otherfile: touch in\n"
590 "build out: touch in | in1\n"));
592 fs_.Create("in", "");
594 fs_.Create("in1", "");
597 EXPECT_TRUE(builder_.AddTarget("out", &err));
599 EXPECT_TRUE(builder_.Build(&err));
603 TEST_F(BuildTest, Chain) {
604 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
608 "build c5: cat c4\n"));
610 fs_.Create("c1", "");
613 EXPECT_TRUE(builder_.AddTarget("c5", &err));
615 EXPECT_TRUE(builder_.Build(&err));
617 ASSERT_EQ(4u, command_runner_.commands_ran_.size());
620 command_runner_.commands_ran_.clear();
622 EXPECT_TRUE(builder_.AddTarget("c5", &err));
624 EXPECT_TRUE(builder_.AlreadyUpToDate());
628 fs_.Create("c3", "");
630 command_runner_.commands_ran_.clear();
632 EXPECT_TRUE(builder_.AddTarget("c5", &err));
634 EXPECT_FALSE(builder_.AlreadyUpToDate());
635 EXPECT_TRUE(builder_.Build(&err));
636 ASSERT_EQ(2u, command_runner_.commands_ran_.size()); // 3->4, 4->5
639 TEST_F(BuildTest, MissingInput) {
640 // Input is referenced by build file, but no rule for it.
643 EXPECT_FALSE(builder_.AddTarget("cat1", &err));
644 EXPECT_EQ("'in1', needed by 'cat1', missing and no known rule to make it",
648 TEST_F(BuildTest, MissingTarget) {
649 // Target is not referenced by build file.
651 EXPECT_FALSE(builder_.AddTarget("meow", &err));
652 EXPECT_EQ("unknown target: 'meow'", err);
655 TEST_F(BuildTest, MakeDirs) {
659 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
660 "build subdir\\dir2\\file: cat in1\n"));
661 EXPECT_TRUE(builder_.AddTarget("subdir\\dir2\\file", &err));
663 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
664 "build subdir/dir2/file: cat in1\n"));
665 EXPECT_TRUE(builder_.AddTarget("subdir/dir2/file", &err));
669 EXPECT_TRUE(builder_.Build(&err));
671 ASSERT_EQ(2u, fs_.directories_made_.size());
672 EXPECT_EQ("subdir", fs_.directories_made_[0]);
674 EXPECT_EQ("subdir\\dir2", fs_.directories_made_[1]);
676 EXPECT_EQ("subdir/dir2", fs_.directories_made_[1]);
680 TEST_F(BuildTest, DepFileMissing) {
682 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
683 "rule cc\n command = cc $in\n depfile = $out.d\n"
684 "build foo.o: cc foo.c\n"));
685 fs_.Create("foo.c", "");
687 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
689 ASSERT_EQ(1u, fs_.files_read_.size());
690 EXPECT_EQ("foo.o.d", fs_.files_read_[0]);
693 TEST_F(BuildTest, DepFileOK) {
695 int orig_edges = state_.edges_.size();
696 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
697 "rule cc\n command = cc $in\n depfile = $out.d\n"
698 "build foo.o: cc foo.c\n"));
699 Edge* edge = state_.edges_.back();
701 fs_.Create("foo.c", "");
702 GetNode("bar.h")->MarkDirty(); // Mark bar.h as missing.
703 fs_.Create("foo.o.d", "foo.o: blah.h bar.h\n");
704 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
706 ASSERT_EQ(1u, fs_.files_read_.size());
707 EXPECT_EQ("foo.o.d", fs_.files_read_[0]);
709 // Expect three new edges: one generating foo.o, and two more from
710 // loading the depfile.
711 ASSERT_EQ(orig_edges + 3, (int)state_.edges_.size());
712 // Expect our edge to now have three inputs: foo.c and two headers.
713 ASSERT_EQ(3u, edge->inputs_.size());
715 // Expect the command line we generate to only use the original input.
716 ASSERT_EQ("cc foo.c", edge->EvaluateCommand());
719 TEST_F(BuildTest, DepFileParseError) {
721 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
722 "rule cc\n command = cc $in\n depfile = $out.d\n"
723 "build foo.o: cc foo.c\n"));
724 fs_.Create("foo.c", "");
725 fs_.Create("foo.o.d", "randomtext\n");
726 EXPECT_FALSE(builder_.AddTarget("foo.o", &err));
727 EXPECT_EQ("expected depfile 'foo.o.d' to mention 'foo.o', got 'randomtext'",
731 TEST_F(BuildTest, OrderOnlyDeps) {
733 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
734 "rule cc\n command = cc $in\n depfile = $out.d\n"
735 "build foo.o: cc foo.c || otherfile\n"));
736 Edge* edge = state_.edges_.back();
738 fs_.Create("foo.c", "");
739 fs_.Create("otherfile", "");
740 fs_.Create("foo.o.d", "foo.o: blah.h bar.h\n");
741 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
744 // One explicit, two implicit, one order only.
745 ASSERT_EQ(4u, edge->inputs_.size());
746 EXPECT_EQ(2, edge->implicit_deps_);
747 EXPECT_EQ(1, edge->order_only_deps_);
748 // Verify the inputs are in the order we expect
749 // (explicit then implicit then orderonly).
750 EXPECT_EQ("foo.c", edge->inputs_[0]->path());
751 EXPECT_EQ("blah.h", edge->inputs_[1]->path());
752 EXPECT_EQ("bar.h", edge->inputs_[2]->path());
753 EXPECT_EQ("otherfile", edge->inputs_[3]->path());
755 // Expect the command line we generate to only use the original input.
756 ASSERT_EQ("cc foo.c", edge->EvaluateCommand());
758 // explicit dep dirty, expect a rebuild.
759 EXPECT_TRUE(builder_.Build(&err));
761 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
765 // Recreate the depfile, as it should have been deleted by the build.
766 fs_.Create("foo.o.d", "foo.o: blah.h bar.h\n");
768 // implicit dep dirty, expect a rebuild.
769 fs_.Create("blah.h", "");
770 fs_.Create("bar.h", "");
771 command_runner_.commands_ran_.clear();
773 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
774 EXPECT_TRUE(builder_.Build(&err));
776 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
780 // Recreate the depfile, as it should have been deleted by the build.
781 fs_.Create("foo.o.d", "foo.o: blah.h bar.h\n");
783 // order only dep dirty, no rebuild.
784 fs_.Create("otherfile", "");
785 command_runner_.commands_ran_.clear();
787 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
789 EXPECT_TRUE(builder_.AlreadyUpToDate());
791 // implicit dep missing, expect rebuild.
792 fs_.RemoveFile("bar.h");
793 command_runner_.commands_ran_.clear();
795 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
796 EXPECT_TRUE(builder_.Build(&err));
798 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
801 TEST_F(BuildTest, RebuildOrderOnlyDeps) {
803 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
804 "rule cc\n command = cc $in\n"
805 "rule true\n command = true\n"
806 "build oo.h: cc oo.h.in\n"
807 "build foo.o: cc foo.c || oo.h\n"));
809 fs_.Create("foo.c", "");
810 fs_.Create("oo.h.in", "");
812 // foo.o and order-only dep dirty, build both.
813 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
814 EXPECT_TRUE(builder_.Build(&err));
816 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
818 // all clean, no rebuild.
819 command_runner_.commands_ran_.clear();
821 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
823 EXPECT_TRUE(builder_.AlreadyUpToDate());
825 // order-only dep missing, build it only.
826 fs_.RemoveFile("oo.h");
827 command_runner_.commands_ran_.clear();
829 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
830 EXPECT_TRUE(builder_.Build(&err));
832 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
833 ASSERT_EQ("cc oo.h.in", command_runner_.commands_ran_[0]);
837 // order-only dep dirty, build it only.
838 fs_.Create("oo.h.in", "");
839 command_runner_.commands_ran_.clear();
841 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
842 EXPECT_TRUE(builder_.Build(&err));
844 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
845 ASSERT_EQ("cc oo.h.in", command_runner_.commands_ran_[0]);
848 TEST_F(BuildTest, Phony) {
850 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
851 "build out: cat bar.cc\n"
852 "build all: phony out\n"));
853 fs_.Create("bar.cc", "");
855 EXPECT_TRUE(builder_.AddTarget("all", &err));
858 // Only one command to run, because phony runs no command.
859 EXPECT_FALSE(builder_.AlreadyUpToDate());
860 EXPECT_TRUE(builder_.Build(&err));
862 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
865 TEST_F(BuildTest, PhonyNoWork) {
867 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
868 "build out: cat bar.cc\n"
869 "build all: phony out\n"));
870 fs_.Create("bar.cc", "");
871 fs_.Create("out", "");
873 EXPECT_TRUE(builder_.AddTarget("all", &err));
875 EXPECT_TRUE(builder_.AlreadyUpToDate());
878 TEST_F(BuildTest, Fail) {
879 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
882 "build out1: fail\n"));
885 EXPECT_TRUE(builder_.AddTarget("out1", &err));
888 EXPECT_FALSE(builder_.Build(&err));
889 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
890 ASSERT_EQ("subcommand failed", err);
893 TEST_F(BuildTest, SwallowFailures) {
894 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
900 "build all: phony out1 out2 out3\n"));
902 // Swallow two failures, die on the third.
903 config_.failures_allowed = 3;
906 EXPECT_TRUE(builder_.AddTarget("all", &err));
909 EXPECT_FALSE(builder_.Build(&err));
910 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
911 ASSERT_EQ("subcommands failed", err);
914 TEST_F(BuildTest, SwallowFailuresLimit) {
915 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
921 "build final: cat out1 out2 out3\n"));
923 // Swallow ten failures; we should stop before building final.
924 config_.failures_allowed = 11;
927 EXPECT_TRUE(builder_.AddTarget("final", &err));
930 EXPECT_FALSE(builder_.Build(&err));
931 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
932 ASSERT_EQ("cannot make progress due to previous errors", err);
935 struct BuildWithLogTest : public BuildTest {
937 builder_.SetBuildLog(&build_log_);
943 TEST_F(BuildWithLogTest, NotInLogButOnDisk) {
944 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
947 "build out1: cc in\n"));
949 // Create input/output that would be considered up to date when
950 // not considering the command line hash.
951 fs_.Create("in", "");
952 fs_.Create("out1", "");
955 // Because it's not in the log, it should not be up-to-date until
957 EXPECT_TRUE(builder_.AddTarget("out1", &err));
958 EXPECT_FALSE(builder_.AlreadyUpToDate());
960 command_runner_.commands_ran_.clear();
963 EXPECT_TRUE(builder_.AddTarget("out1", &err));
964 EXPECT_TRUE(builder_.Build(&err));
965 EXPECT_TRUE(builder_.AlreadyUpToDate());
968 TEST_F(BuildWithLogTest, RestatTest) {
969 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
976 "build out1: cc in\n"
977 "build out2: true out1\n"
978 "build out3: cat out2\n"));
980 fs_.Create("out1", "");
981 fs_.Create("out2", "");
982 fs_.Create("out3", "");
986 fs_.Create("in", "");
988 // Do a pre-build so that there's commands in the log for the outputs,
989 // otherwise, the lack of an entry in the build log will cause out3 to rebuild
990 // regardless of restat.
992 EXPECT_TRUE(builder_.AddTarget("out3", &err));
994 EXPECT_TRUE(builder_.Build(&err));
996 command_runner_.commands_ran_.clear();
1001 fs_.Create("in", "");
1002 // "cc" touches out1, so we should build out2. But because "true" does not
1003 // touch out2, we should cancel the build of out3.
1004 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1006 EXPECT_TRUE(builder_.Build(&err));
1007 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
1009 // If we run again, it should be a no-op, because the build log has recorded
1010 // that we've already built out2 with an input timestamp of 2 (from out1).
1011 command_runner_.commands_ran_.clear();
1013 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1015 EXPECT_TRUE(builder_.AlreadyUpToDate());
1019 fs_.Create("in", "");
1021 // The build log entry should not, however, prevent us from rebuilding out2
1023 command_runner_.commands_ran_.clear();
1025 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1027 EXPECT_TRUE(builder_.Build(&err));
1028 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
1031 TEST_F(BuildWithLogTest, RestatMissingFile) {
1032 // If a restat rule doesn't create its output, and the output didn't
1033 // exist before the rule was run, consider that behavior equivalent
1034 // to a rule that doesn't modify its existent output file.
1036 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1042 "build out1: true in\n"
1043 "build out2: cc out1\n"));
1045 fs_.Create("in", "");
1046 fs_.Create("out2", "");
1048 // Do a pre-build so that there's commands in the log for the outputs,
1049 // otherwise, the lack of an entry in the build log will cause out2 to rebuild
1050 // regardless of restat.
1052 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1054 EXPECT_TRUE(builder_.Build(&err));
1056 command_runner_.commands_ran_.clear();
1060 fs_.Create("in", "");
1061 fs_.Create("out2", "");
1063 // Run a build, expect only the first command to run.
1064 // It doesn't touch its output (due to being the "true" command), so
1065 // we shouldn't run the dependent build.
1066 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1068 EXPECT_TRUE(builder_.Build(&err));
1069 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1072 // Test scenario, in which an input file is removed, but output isn't changed
1073 // https://github.com/martine/ninja/issues/295
1074 TEST_F(BuildWithLogTest, RestatMissingInput) {
1075 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1078 " depfile = $out.d\n"
1082 "build out1: true in\n"
1083 "build out2: cc out1\n"));
1085 // Create all necessary files
1086 fs_.Create("in", "");
1088 // The implicit dependencies and the depfile itself
1089 // are newer than the output
1090 TimeStamp restat_mtime = fs_.Tick();
1091 fs_.Create("out1.d", "out1: will.be.deleted restat.file\n");
1092 fs_.Create("will.be.deleted", "");
1093 fs_.Create("restat.file", "");
1095 // Run the build, out1 and out2 get built
1097 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1099 EXPECT_TRUE(builder_.Build(&err));
1100 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
1102 // See that an entry in the logfile is created, capturing
1104 BuildLog::LogEntry * log_entry = build_log_.LookupByOutput("out1");
1105 ASSERT_TRUE(NULL != log_entry);
1106 ASSERT_EQ(restat_mtime, log_entry->restat_mtime);
1108 // Now remove a file, referenced from depfile, so that target becomes
1109 // dirty, but the output does not change
1110 fs_.RemoveFile("will.be.deleted");
1112 // Trigger the build again - only out1 gets built
1113 command_runner_.commands_ran_.clear();
1115 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1117 EXPECT_TRUE(builder_.Build(&err));
1118 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1120 // Check that the logfile entry remains correctly set
1121 log_entry = build_log_.LookupByOutput("out1");
1122 ASSERT_TRUE(NULL != log_entry);
1123 ASSERT_EQ(restat_mtime, log_entry->restat_mtime);
1126 struct BuildDryRun : public BuildWithLogTest {
1128 config_.dry_run = true;
1132 TEST_F(BuildDryRun, AllCommandsShown) {
1133 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1140 "build out1: cc in\n"
1141 "build out2: true out1\n"
1142 "build out3: cat out2\n"));
1144 fs_.Create("out1", "");
1145 fs_.Create("out2", "");
1146 fs_.Create("out3", "");
1150 fs_.Create("in", "");
1152 // "cc" touches out1, so we should build out2. But because "true" does not
1153 // touch out2, we should cancel the build of out3.
1155 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1157 EXPECT_TRUE(builder_.Build(&err));
1158 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
1161 // Test that RSP files are created when & where appropriate and deleted after
1162 // successful execution.
1163 TEST_F(BuildTest, RspFileSuccess)
1165 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1167 " command = cat $rspfile > $out\n"
1168 " rspfile = $rspfile\n"
1169 " rspfile_content = $long_command\n"
1170 "build out1: cat in\n"
1171 "build out2: cat_rsp in\n"
1172 " rspfile = out2.rsp\n"
1173 " long_command = Some very long command\n"));
1175 fs_.Create("out1", "");
1176 fs_.Create("out2", "");
1177 fs_.Create("out3", "");
1181 fs_.Create("in", "");
1184 EXPECT_TRUE(builder_.AddTarget("out1", &err));
1186 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1189 size_t files_created = fs_.files_created_.size();
1190 size_t files_removed = fs_.files_removed_.size();
1192 EXPECT_TRUE(builder_.Build(&err));
1193 ASSERT_EQ(2u, command_runner_.commands_ran_.size()); // cat + cat_rsp
1195 // The RSP file was created
1196 ASSERT_EQ(files_created + 1, fs_.files_created_.size());
1197 ASSERT_EQ(1u, fs_.files_created_.count("out2.rsp"));
1199 // The RSP file was removed
1200 ASSERT_EQ(files_removed + 1, fs_.files_removed_.size());
1201 ASSERT_EQ(1u, fs_.files_removed_.count("out2.rsp"));
1204 // Test that RSP file is created but not removed for commands, which fail
1205 TEST_F(BuildTest, RspFileFailure) {
1206 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1209 " rspfile = $rspfile\n"
1210 " rspfile_content = $long_command\n"
1211 "build out: fail in\n"
1212 " rspfile = out.rsp\n"
1213 " long_command = Another very long command\n"));
1215 fs_.Create("out", "");
1217 fs_.Create("in", "");
1220 EXPECT_TRUE(builder_.AddTarget("out", &err));
1223 size_t files_created = fs_.files_created_.size();
1224 size_t files_removed = fs_.files_removed_.size();
1226 EXPECT_FALSE(builder_.Build(&err));
1227 ASSERT_EQ("subcommand failed", err);
1228 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1230 // The RSP file was created
1231 ASSERT_EQ(files_created + 1, fs_.files_created_.size());
1232 ASSERT_EQ(1u, fs_.files_created_.count("out.rsp"));
1234 // The RSP file was NOT removed
1235 ASSERT_EQ(files_removed, fs_.files_removed_.size());
1236 ASSERT_EQ(0u, fs_.files_removed_.count("out.rsp"));
1238 // The RSP file contains what it should
1239 ASSERT_EQ("Another very long command", fs_.files_["out.rsp"].contents);
1242 // Test that contens of the RSP file behaves like a regular part of
1243 // command line, i.e. triggers a rebuild if changed
1244 TEST_F(BuildWithLogTest, RspFileCmdLineChange) {
1245 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1247 " command = cat $rspfile > $out\n"
1248 " rspfile = $rspfile\n"
1249 " rspfile_content = $long_command\n"
1250 "build out: cat_rsp in\n"
1251 " rspfile = out.rsp\n"
1252 " long_command = Original very long command\n"));
1254 fs_.Create("out", "");
1256 fs_.Create("in", "");
1259 EXPECT_TRUE(builder_.AddTarget("out", &err));
1262 // 1. Build for the 1st time (-> populate log)
1263 EXPECT_TRUE(builder_.Build(&err));
1264 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1266 // 2. Build again (no change)
1267 command_runner_.commands_ran_.clear();
1269 EXPECT_TRUE(builder_.AddTarget("out", &err));
1271 ASSERT_TRUE(builder_.AlreadyUpToDate());
1273 // 3. Alter the entry in the logfile
1274 // (to simulate a change in the command line between 2 builds)
1275 BuildLog::LogEntry * log_entry = build_log_.LookupByOutput("out");
1276 ASSERT_TRUE(NULL != log_entry);
1277 ASSERT_NO_FATAL_FAILURE(AssertHash(
1278 "cat out.rsp > out;rspfile=Original very long command",
1279 log_entry->command_hash));
1280 log_entry->command_hash++; // Change the command hash to something else.
1281 // Now expect the target to be rebuilt
1282 command_runner_.commands_ran_.clear();
1284 EXPECT_TRUE(builder_.AddTarget("out", &err));
1286 EXPECT_TRUE(builder_.Build(&err));
1287 EXPECT_EQ(1u, command_runner_.commands_ran_.size());
1290 TEST_F(BuildTest, InterruptCleanup) {
1291 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1293 " command = interrupt\n"
1294 "rule touch-interrupt\n"
1295 " command = touch-interrupt\n"
1296 "build out1: interrupt in1\n"
1297 "build out2: touch-interrupt in2\n"));
1299 fs_.Create("out1", "");
1300 fs_.Create("out2", "");
1302 fs_.Create("in1", "");
1303 fs_.Create("in2", "");
1305 // An untouched output of an interrupted command should be retained.
1307 EXPECT_TRUE(builder_.AddTarget("out1", &err));
1309 EXPECT_FALSE(builder_.Build(&err));
1310 EXPECT_EQ("interrupted by user", err);
1312 EXPECT_GT(fs_.Stat("out1"), 0);
1315 // A touched output of an interrupted command should be deleted.
1316 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1318 EXPECT_FALSE(builder_.Build(&err));
1319 EXPECT_EQ("interrupted by user", err);
1321 EXPECT_EQ(0, fs_.Stat("out2"));
1324 TEST_F(BuildTest, PhonyWithNoInputs) {
1325 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1326 "build nonexistent: phony\n"
1327 "build out1: cat || nonexistent\n"
1328 "build out2: cat nonexistent\n"));
1329 fs_.Create("out1", "");
1330 fs_.Create("out2", "");
1332 // out1 should be up to date even though its input is dirty, because its
1333 // order-only dependency has nothing to do.
1335 EXPECT_TRUE(builder_.AddTarget("out1", &err));
1337 EXPECT_TRUE(builder_.AlreadyUpToDate());
1339 // out2 should still be out of date though, because its input is dirty.
1341 command_runner_.commands_ran_.clear();
1343 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1345 EXPECT_TRUE(builder_.Build(&err));
1347 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1350 TEST_F(BuildTest, StatusFormatReplacePlaceholder) {
1351 EXPECT_EQ("[%/s0/t0/r0/u0/f0]",
1352 status_.FormatProgressStatus("[%%/s%s/t%t/r%r/u%u/f%f]"));