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 Edge* WaitForCommand(ExitStatus* status, string* output);
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, &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 Edge* FakeCommandRunner::WaitForCommand(ExitStatus* status,
461 string* /* output */) {
462 if (Edge* edge = last_command_) {
463 if (edge->rule().name() == "interrupt" ||
464 edge->rule().name() == "touch-interrupt") {
465 *status = ExitInterrupted;
469 if (edge->rule().name() == "fail")
470 *status = ExitFailure;
472 *status = ExitSuccess;
473 last_command_ = NULL;
476 *status = ExitFailure;
480 vector<Edge*> FakeCommandRunner::GetActiveEdges() {
483 edges.push_back(last_command_);
487 void FakeCommandRunner::Abort() {
488 last_command_ = NULL;
491 void BuildTest::Dirty(const string& path) {
492 Node* node = GetNode(path);
495 // If it's an input file, mark that we've already stat()ed it and
497 if (!node->in_edge())
501 TEST_F(BuildTest, NoWork) {
503 EXPECT_TRUE(builder_.AlreadyUpToDate());
506 TEST_F(BuildTest, OneStep) {
507 // Given a dirty target with one ready input,
508 // we should rebuild the target.
511 EXPECT_TRUE(builder_.AddTarget("cat1", &err));
513 EXPECT_TRUE(builder_.Build(&err));
516 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
517 EXPECT_EQ("cat in1 > cat1", command_runner_.commands_ran_[0]);
520 TEST_F(BuildTest, OneStep2) {
521 // Given a target with one dirty input,
522 // we should rebuild the target.
525 EXPECT_TRUE(builder_.AddTarget("cat1", &err));
527 EXPECT_TRUE(builder_.Build(&err));
530 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
531 EXPECT_EQ("cat in1 > cat1", command_runner_.commands_ran_[0]);
534 TEST_F(BuildTest, TwoStep) {
536 EXPECT_TRUE(builder_.AddTarget("cat12", &err));
538 EXPECT_TRUE(builder_.Build(&err));
540 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
541 // Depending on how the pointers work out, we could've ran
542 // the first two commands in either order.
543 EXPECT_TRUE((command_runner_.commands_ran_[0] == "cat in1 > cat1" &&
544 command_runner_.commands_ran_[1] == "cat in1 in2 > cat2") ||
545 (command_runner_.commands_ran_[1] == "cat in1 > cat1" &&
546 command_runner_.commands_ran_[0] == "cat in1 in2 > cat2"));
548 EXPECT_EQ("cat cat1 cat2 > cat12", command_runner_.commands_ran_[2]);
552 // Modifying in2 requires rebuilding one intermediate file
553 // and the final file.
554 fs_.Create("in2", "");
556 EXPECT_TRUE(builder_.AddTarget("cat12", &err));
558 EXPECT_TRUE(builder_.Build(&err));
560 ASSERT_EQ(5u, command_runner_.commands_ran_.size());
561 EXPECT_EQ("cat in1 in2 > cat2", command_runner_.commands_ran_[3]);
562 EXPECT_EQ("cat cat1 cat2 > cat12", command_runner_.commands_ran_[4]);
565 TEST_F(BuildTest, TwoOutputs) {
566 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
568 " command = touch $out\n"
569 "build out1 out2: touch in.txt\n"));
571 fs_.Create("in.txt", "");
574 EXPECT_TRUE(builder_.AddTarget("out1", &err));
576 EXPECT_TRUE(builder_.Build(&err));
578 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
579 EXPECT_EQ("touch out1 out2", command_runner_.commands_ran_[0]);
583 // https://github.com/martine/ninja/issues/148
584 TEST_F(BuildTest, MultiOutIn) {
585 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
587 " command = touch $out\n"
588 "build in1 otherfile: touch in\n"
589 "build out: touch in | in1\n"));
591 fs_.Create("in", "");
593 fs_.Create("in1", "");
596 EXPECT_TRUE(builder_.AddTarget("out", &err));
598 EXPECT_TRUE(builder_.Build(&err));
602 TEST_F(BuildTest, Chain) {
603 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
607 "build c5: cat c4\n"));
609 fs_.Create("c1", "");
612 EXPECT_TRUE(builder_.AddTarget("c5", &err));
614 EXPECT_TRUE(builder_.Build(&err));
616 ASSERT_EQ(4u, command_runner_.commands_ran_.size());
619 command_runner_.commands_ran_.clear();
621 EXPECT_TRUE(builder_.AddTarget("c5", &err));
623 EXPECT_TRUE(builder_.AlreadyUpToDate());
627 fs_.Create("c3", "");
629 command_runner_.commands_ran_.clear();
631 EXPECT_TRUE(builder_.AddTarget("c5", &err));
633 EXPECT_FALSE(builder_.AlreadyUpToDate());
634 EXPECT_TRUE(builder_.Build(&err));
635 ASSERT_EQ(2u, command_runner_.commands_ran_.size()); // 3->4, 4->5
638 TEST_F(BuildTest, MissingInput) {
639 // Input is referenced by build file, but no rule for it.
642 EXPECT_FALSE(builder_.AddTarget("cat1", &err));
643 EXPECT_EQ("'in1', needed by 'cat1', missing and no known rule to make it",
647 TEST_F(BuildTest, MissingTarget) {
648 // Target is not referenced by build file.
650 EXPECT_FALSE(builder_.AddTarget("meow", &err));
651 EXPECT_EQ("unknown target: 'meow'", err);
654 TEST_F(BuildTest, MakeDirs) {
658 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
659 "build subdir\\dir2\\file: cat in1\n"));
660 EXPECT_TRUE(builder_.AddTarget("subdir\\dir2\\file", &err));
662 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
663 "build subdir/dir2/file: cat in1\n"));
664 EXPECT_TRUE(builder_.AddTarget("subdir/dir2/file", &err));
668 EXPECT_TRUE(builder_.Build(&err));
670 ASSERT_EQ(2u, fs_.directories_made_.size());
671 EXPECT_EQ("subdir", fs_.directories_made_[0]);
673 EXPECT_EQ("subdir\\dir2", fs_.directories_made_[1]);
675 EXPECT_EQ("subdir/dir2", fs_.directories_made_[1]);
679 TEST_F(BuildTest, DepFileMissing) {
681 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
682 "rule cc\n command = cc $in\n depfile = $out.d\n"
683 "build foo.o: cc foo.c\n"));
684 fs_.Create("foo.c", "");
686 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
688 ASSERT_EQ(1u, fs_.files_read_.size());
689 EXPECT_EQ("foo.o.d", fs_.files_read_[0]);
692 TEST_F(BuildTest, DepFileOK) {
694 int orig_edges = state_.edges_.size();
695 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
696 "rule cc\n command = cc $in\n depfile = $out.d\n"
697 "build foo.o: cc foo.c\n"));
698 Edge* edge = state_.edges_.back();
700 fs_.Create("foo.c", "");
701 GetNode("bar.h")->MarkDirty(); // Mark bar.h as missing.
702 fs_.Create("foo.o.d", "foo.o: blah.h bar.h\n");
703 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
705 ASSERT_EQ(1u, fs_.files_read_.size());
706 EXPECT_EQ("foo.o.d", fs_.files_read_[0]);
708 // Expect three new edges: one generating foo.o, and two more from
709 // loading the depfile.
710 ASSERT_EQ(orig_edges + 3, (int)state_.edges_.size());
711 // Expect our edge to now have three inputs: foo.c and two headers.
712 ASSERT_EQ(3u, edge->inputs_.size());
714 // Expect the command line we generate to only use the original input.
715 ASSERT_EQ("cc foo.c", edge->EvaluateCommand());
718 TEST_F(BuildTest, DepFileParseError) {
720 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
721 "rule cc\n command = cc $in\n depfile = $out.d\n"
722 "build foo.o: cc foo.c\n"));
723 fs_.Create("foo.c", "");
724 fs_.Create("foo.o.d", "randomtext\n");
725 EXPECT_FALSE(builder_.AddTarget("foo.o", &err));
726 EXPECT_EQ("expected depfile 'foo.o.d' to mention 'foo.o', got 'randomtext'",
730 TEST_F(BuildTest, OrderOnlyDeps) {
732 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
733 "rule cc\n command = cc $in\n depfile = $out.d\n"
734 "build foo.o: cc foo.c || otherfile\n"));
735 Edge* edge = state_.edges_.back();
737 fs_.Create("foo.c", "");
738 fs_.Create("otherfile", "");
739 fs_.Create("foo.o.d", "foo.o: blah.h bar.h\n");
740 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
743 // One explicit, two implicit, one order only.
744 ASSERT_EQ(4u, edge->inputs_.size());
745 EXPECT_EQ(2, edge->implicit_deps_);
746 EXPECT_EQ(1, edge->order_only_deps_);
747 // Verify the inputs are in the order we expect
748 // (explicit then implicit then orderonly).
749 EXPECT_EQ("foo.c", edge->inputs_[0]->path());
750 EXPECT_EQ("blah.h", edge->inputs_[1]->path());
751 EXPECT_EQ("bar.h", edge->inputs_[2]->path());
752 EXPECT_EQ("otherfile", edge->inputs_[3]->path());
754 // Expect the command line we generate to only use the original input.
755 ASSERT_EQ("cc foo.c", edge->EvaluateCommand());
757 // explicit dep dirty, expect a rebuild.
758 EXPECT_TRUE(builder_.Build(&err));
760 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
764 // implicit dep dirty, expect a rebuild.
765 fs_.Create("blah.h", "");
766 fs_.Create("bar.h", "");
767 command_runner_.commands_ran_.clear();
769 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
770 EXPECT_TRUE(builder_.Build(&err));
772 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
776 // order only dep dirty, no rebuild.
777 fs_.Create("otherfile", "");
778 command_runner_.commands_ran_.clear();
780 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
782 EXPECT_TRUE(builder_.AlreadyUpToDate());
784 // implicit dep missing, expect rebuild.
785 fs_.RemoveFile("bar.h");
786 command_runner_.commands_ran_.clear();
788 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
789 EXPECT_TRUE(builder_.Build(&err));
791 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
794 TEST_F(BuildTest, RebuildOrderOnlyDeps) {
796 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
797 "rule cc\n command = cc $in\n"
798 "rule true\n command = true\n"
799 "build oo.h: cc oo.h.in\n"
800 "build foo.o: cc foo.c || oo.h\n"));
802 fs_.Create("foo.c", "");
803 fs_.Create("oo.h.in", "");
805 // foo.o and order-only dep dirty, build both.
806 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
807 EXPECT_TRUE(builder_.Build(&err));
809 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
811 // all clean, no rebuild.
812 command_runner_.commands_ran_.clear();
814 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
816 EXPECT_TRUE(builder_.AlreadyUpToDate());
818 // order-only dep missing, build it only.
819 fs_.RemoveFile("oo.h");
820 command_runner_.commands_ran_.clear();
822 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
823 EXPECT_TRUE(builder_.Build(&err));
825 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
826 ASSERT_EQ("cc oo.h.in", command_runner_.commands_ran_[0]);
830 // order-only dep dirty, build it only.
831 fs_.Create("oo.h.in", "");
832 command_runner_.commands_ran_.clear();
834 EXPECT_TRUE(builder_.AddTarget("foo.o", &err));
835 EXPECT_TRUE(builder_.Build(&err));
837 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
838 ASSERT_EQ("cc oo.h.in", command_runner_.commands_ran_[0]);
841 TEST_F(BuildTest, Phony) {
843 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
844 "build out: cat bar.cc\n"
845 "build all: phony out\n"));
846 fs_.Create("bar.cc", "");
848 EXPECT_TRUE(builder_.AddTarget("all", &err));
851 // Only one command to run, because phony runs no command.
852 EXPECT_FALSE(builder_.AlreadyUpToDate());
853 EXPECT_TRUE(builder_.Build(&err));
855 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
858 TEST_F(BuildTest, PhonyNoWork) {
860 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
861 "build out: cat bar.cc\n"
862 "build all: phony out\n"));
863 fs_.Create("bar.cc", "");
864 fs_.Create("out", "");
866 EXPECT_TRUE(builder_.AddTarget("all", &err));
868 EXPECT_TRUE(builder_.AlreadyUpToDate());
871 TEST_F(BuildTest, Fail) {
872 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
875 "build out1: fail\n"));
878 EXPECT_TRUE(builder_.AddTarget("out1", &err));
881 EXPECT_FALSE(builder_.Build(&err));
882 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
883 ASSERT_EQ("subcommand failed", err);
886 TEST_F(BuildTest, SwallowFailures) {
887 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
893 "build all: phony out1 out2 out3\n"));
895 // Swallow two failures, die on the third.
896 config_.failures_allowed = 3;
899 EXPECT_TRUE(builder_.AddTarget("all", &err));
902 EXPECT_FALSE(builder_.Build(&err));
903 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
904 ASSERT_EQ("subcommands failed", err);
907 TEST_F(BuildTest, SwallowFailuresLimit) {
908 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
914 "build final: cat out1 out2 out3\n"));
916 // Swallow ten failures; we should stop before building final.
917 config_.failures_allowed = 11;
920 EXPECT_TRUE(builder_.AddTarget("final", &err));
923 EXPECT_FALSE(builder_.Build(&err));
924 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
925 ASSERT_EQ("cannot make progress due to previous errors", err);
928 struct BuildWithLogTest : public BuildTest {
930 builder_.SetBuildLog(&build_log_);
936 TEST_F(BuildWithLogTest, NotInLogButOnDisk) {
937 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
940 "build out1: cc in\n"));
942 // Create input/output that would be considered up to date when
943 // not considering the command line hash.
944 fs_.Create("in", "");
945 fs_.Create("out1", "");
948 // Because it's not in the log, it should not be up-to-date until
950 EXPECT_TRUE(builder_.AddTarget("out1", &err));
951 EXPECT_FALSE(builder_.AlreadyUpToDate());
953 command_runner_.commands_ran_.clear();
956 EXPECT_TRUE(builder_.AddTarget("out1", &err));
957 EXPECT_TRUE(builder_.Build(&err));
958 EXPECT_TRUE(builder_.AlreadyUpToDate());
961 TEST_F(BuildWithLogTest, RestatTest) {
962 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
969 "build out1: cc in\n"
970 "build out2: true out1\n"
971 "build out3: cat out2\n"));
973 fs_.Create("out1", "");
974 fs_.Create("out2", "");
975 fs_.Create("out3", "");
979 fs_.Create("in", "");
981 // Do a pre-build so that there's commands in the log for the outputs,
982 // otherwise, the lack of an entry in the build log will cause out3 to rebuild
983 // regardless of restat.
985 EXPECT_TRUE(builder_.AddTarget("out3", &err));
987 EXPECT_TRUE(builder_.Build(&err));
989 command_runner_.commands_ran_.clear();
994 fs_.Create("in", "");
995 // "cc" touches out1, so we should build out2. But because "true" does not
996 // touch out2, we should cancel the build of out3.
997 EXPECT_TRUE(builder_.AddTarget("out3", &err));
999 EXPECT_TRUE(builder_.Build(&err));
1000 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
1002 // If we run again, it should be a no-op, because the build log has recorded
1003 // that we've already built out2 with an input timestamp of 2 (from out1).
1004 command_runner_.commands_ran_.clear();
1006 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1008 EXPECT_TRUE(builder_.AlreadyUpToDate());
1012 fs_.Create("in", "");
1014 // The build log entry should not, however, prevent us from rebuilding out2
1016 command_runner_.commands_ran_.clear();
1018 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1020 EXPECT_TRUE(builder_.Build(&err));
1021 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
1024 TEST_F(BuildWithLogTest, RestatMissingFile) {
1025 // If a restat rule doesn't create its output, and the output didn't
1026 // exist before the rule was run, consider that behavior equivalent
1027 // to a rule that doesn't modify its existent output file.
1029 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1035 "build out1: true in\n"
1036 "build out2: cc out1\n"));
1038 fs_.Create("in", "");
1039 fs_.Create("out2", "");
1041 // Do a pre-build so that there's commands in the log for the outputs,
1042 // otherwise, the lack of an entry in the build log will cause out2 to rebuild
1043 // regardless of restat.
1045 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1047 EXPECT_TRUE(builder_.Build(&err));
1049 command_runner_.commands_ran_.clear();
1053 fs_.Create("in", "");
1054 fs_.Create("out2", "");
1056 // Run a build, expect only the first command to run.
1057 // It doesn't touch its output (due to being the "true" command), so
1058 // we shouldn't run the dependent build.
1059 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1061 EXPECT_TRUE(builder_.Build(&err));
1062 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1065 // Test scenario, in which an input file is removed, but output isn't changed
1066 // https://github.com/martine/ninja/issues/295
1067 TEST_F(BuildWithLogTest, RestatMissingInput) {
1068 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1071 " depfile = $out.d\n"
1075 "build out1: true in\n"
1076 "build out2: cc out1\n"));
1078 // Create all necessary files
1079 fs_.Create("in", "");
1081 // The implicit dependencies and the depfile itself
1082 // are newer than the output
1083 TimeStamp restat_mtime = fs_.Tick();
1084 fs_.Create("out1.d", "out1: will.be.deleted restat.file\n");
1085 fs_.Create("will.be.deleted", "");
1086 fs_.Create("restat.file", "");
1088 // Run the build, out1 and out2 get built
1090 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1092 EXPECT_TRUE(builder_.Build(&err));
1093 ASSERT_EQ(2u, command_runner_.commands_ran_.size());
1095 // See that an entry in the logfile is created, capturing
1097 BuildLog::LogEntry * log_entry = build_log_.LookupByOutput("out1");
1098 ASSERT_TRUE(NULL != log_entry);
1099 ASSERT_EQ(restat_mtime, log_entry->restat_mtime);
1101 // Now remove a file, referenced from depfile, so that target becomes
1102 // dirty, but the output does not change
1103 fs_.RemoveFile("will.be.deleted");
1105 // Trigger the build again - only out1 gets built
1106 command_runner_.commands_ran_.clear();
1108 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1110 EXPECT_TRUE(builder_.Build(&err));
1111 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1113 // Check that the logfile entry remains correctly set
1114 log_entry = build_log_.LookupByOutput("out1");
1115 ASSERT_TRUE(NULL != log_entry);
1116 ASSERT_EQ(restat_mtime, log_entry->restat_mtime);
1119 struct BuildDryRun : public BuildWithLogTest {
1121 config_.dry_run = true;
1125 TEST_F(BuildDryRun, AllCommandsShown) {
1126 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1133 "build out1: cc in\n"
1134 "build out2: true out1\n"
1135 "build out3: cat out2\n"));
1137 fs_.Create("out1", "");
1138 fs_.Create("out2", "");
1139 fs_.Create("out3", "");
1143 fs_.Create("in", "");
1145 // "cc" touches out1, so we should build out2. But because "true" does not
1146 // touch out2, we should cancel the build of out3.
1148 EXPECT_TRUE(builder_.AddTarget("out3", &err));
1150 EXPECT_TRUE(builder_.Build(&err));
1151 ASSERT_EQ(3u, command_runner_.commands_ran_.size());
1154 // Test that RSP files are created when & where appropriate and deleted after
1155 // successful execution.
1156 TEST_F(BuildTest, RspFileSuccess)
1158 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1160 " command = cat $rspfile > $out\n"
1161 " rspfile = $rspfile\n"
1162 " rspfile_content = $long_command\n"
1163 "build out1: cat in\n"
1164 "build out2: cat_rsp in\n"
1165 " rspfile = out2.rsp\n"
1166 " long_command = Some very long command\n"));
1168 fs_.Create("out1", "");
1169 fs_.Create("out2", "");
1170 fs_.Create("out3", "");
1174 fs_.Create("in", "");
1177 EXPECT_TRUE(builder_.AddTarget("out1", &err));
1179 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1182 size_t files_created = fs_.files_created_.size();
1183 size_t files_removed = fs_.files_removed_.size();
1185 EXPECT_TRUE(builder_.Build(&err));
1186 ASSERT_EQ(2u, command_runner_.commands_ran_.size()); // cat + cat_rsp
1188 // The RSP file was created
1189 ASSERT_EQ(files_created + 1, fs_.files_created_.size());
1190 ASSERT_EQ(1u, fs_.files_created_.count("out2.rsp"));
1192 // The RSP file was removed
1193 ASSERT_EQ(files_removed + 1, fs_.files_removed_.size());
1194 ASSERT_EQ(1u, fs_.files_removed_.count("out2.rsp"));
1197 // Test that RSP file is created but not removed for commands, which fail
1198 TEST_F(BuildTest, RspFileFailure) {
1199 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1202 " rspfile = $rspfile\n"
1203 " rspfile_content = $long_command\n"
1204 "build out: fail in\n"
1205 " rspfile = out.rsp\n"
1206 " long_command = Another very long command\n"));
1208 fs_.Create("out", "");
1210 fs_.Create("in", "");
1213 EXPECT_TRUE(builder_.AddTarget("out", &err));
1216 size_t files_created = fs_.files_created_.size();
1217 size_t files_removed = fs_.files_removed_.size();
1219 EXPECT_FALSE(builder_.Build(&err));
1220 ASSERT_EQ("subcommand failed", err);
1221 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1223 // The RSP file was created
1224 ASSERT_EQ(files_created + 1, fs_.files_created_.size());
1225 ASSERT_EQ(1u, fs_.files_created_.count("out.rsp"));
1227 // The RSP file was NOT removed
1228 ASSERT_EQ(files_removed, fs_.files_removed_.size());
1229 ASSERT_EQ(0u, fs_.files_removed_.count("out.rsp"));
1231 // The RSP file contains what it should
1232 ASSERT_EQ("Another very long command", fs_.files_["out.rsp"].contents);
1235 // Test that contens of the RSP file behaves like a regular part of
1236 // command line, i.e. triggers a rebuild if changed
1237 TEST_F(BuildWithLogTest, RspFileCmdLineChange) {
1238 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1240 " command = cat $rspfile > $out\n"
1241 " rspfile = $rspfile\n"
1242 " rspfile_content = $long_command\n"
1243 "build out: cat_rsp in\n"
1244 " rspfile = out.rsp\n"
1245 " long_command = Original very long command\n"));
1247 fs_.Create("out", "");
1249 fs_.Create("in", "");
1252 EXPECT_TRUE(builder_.AddTarget("out", &err));
1255 // 1. Build for the 1st time (-> populate log)
1256 EXPECT_TRUE(builder_.Build(&err));
1257 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1259 // 2. Build again (no change)
1260 command_runner_.commands_ran_.clear();
1262 EXPECT_TRUE(builder_.AddTarget("out", &err));
1264 ASSERT_TRUE(builder_.AlreadyUpToDate());
1266 // 3. Alter the entry in the logfile
1267 // (to simulate a change in the command line between 2 builds)
1268 BuildLog::LogEntry * log_entry = build_log_.LookupByOutput("out");
1269 ASSERT_TRUE(NULL != log_entry);
1270 ASSERT_NO_FATAL_FAILURE(AssertHash(
1271 "cat out.rsp > out;rspfile=Original very long command",
1272 log_entry->command_hash));
1273 log_entry->command_hash++; // Change the command hash to something else.
1274 // Now expect the target to be rebuilt
1275 command_runner_.commands_ran_.clear();
1277 EXPECT_TRUE(builder_.AddTarget("out", &err));
1279 EXPECT_TRUE(builder_.Build(&err));
1280 EXPECT_EQ(1u, command_runner_.commands_ran_.size());
1283 TEST_F(BuildTest, InterruptCleanup) {
1284 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1286 " command = interrupt\n"
1287 "rule touch-interrupt\n"
1288 " command = touch-interrupt\n"
1289 "build out1: interrupt in1\n"
1290 "build out2: touch-interrupt in2\n"));
1292 fs_.Create("out1", "");
1293 fs_.Create("out2", "");
1295 fs_.Create("in1", "");
1296 fs_.Create("in2", "");
1298 // An untouched output of an interrupted command should be retained.
1300 EXPECT_TRUE(builder_.AddTarget("out1", &err));
1302 EXPECT_FALSE(builder_.Build(&err));
1303 EXPECT_EQ("interrupted by user", err);
1305 EXPECT_GT(fs_.Stat("out1"), 0);
1308 // A touched output of an interrupted command should be deleted.
1309 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1311 EXPECT_FALSE(builder_.Build(&err));
1312 EXPECT_EQ("interrupted by user", err);
1314 EXPECT_EQ(0, fs_.Stat("out2"));
1317 TEST_F(BuildTest, PhonyWithNoInputs) {
1318 ASSERT_NO_FATAL_FAILURE(AssertParse(&state_,
1319 "build nonexistent: phony\n"
1320 "build out1: cat || nonexistent\n"
1321 "build out2: cat nonexistent\n"));
1322 fs_.Create("out1", "");
1323 fs_.Create("out2", "");
1325 // out1 should be up to date even though its input is dirty, because its
1326 // order-only dependency has nothing to do.
1328 EXPECT_TRUE(builder_.AddTarget("out1", &err));
1330 EXPECT_TRUE(builder_.AlreadyUpToDate());
1332 // out2 should still be out of date though, because its input is dirty.
1334 command_runner_.commands_ran_.clear();
1336 EXPECT_TRUE(builder_.AddTarget("out2", &err));
1338 EXPECT_TRUE(builder_.Build(&err));
1340 ASSERT_EQ(1u, command_runner_.commands_ran_.size());
1343 TEST_F(BuildTest, StatusFormatReplacePlaceholder) {
1344 EXPECT_EQ("[%/s0/t0/r0/u0/f0]",
1345 status_.FormatProgressStatus("[%%/s%s/t%t/r%r/u%u/f%f]"));