1 : // Copyright 2013 Google Inc. All Rights Reserved.
2 : //
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
6 : //
7 : // http://www.apache.org/licenses/LICENSE-2.0
8 : //
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.
14 :
15 : #include "syzygy/instrument/instrumenters/coverage_instrumenter.h"
16 :
17 : #include "base/command_line.h"
18 : #include "gtest/gtest.h"
19 : #include "syzygy/core/unittest_util.h"
20 : #include "syzygy/pe/unittest_util.h"
21 :
22 : namespace instrument {
23 : namespace instrumenters {
24 :
25 : namespace {
26 :
27 : class TestCoverageInstrumenter : public CoverageInstrumenter {
28 : public:
29 : using CoverageInstrumenter::agent_dll_;
30 : using CoverageInstrumenter::input_image_path_;
31 : using CoverageInstrumenter::input_pdb_path_;
32 : using CoverageInstrumenter::output_image_path_;
33 : using CoverageInstrumenter::output_pdb_path_;
34 : using CoverageInstrumenter::allow_overwrite_;
35 : using CoverageInstrumenter::no_augment_pdb_;
36 : using CoverageInstrumenter::no_strip_strings_;
37 : using CoverageInstrumenter::debug_friendly_;
38 : using CoverageInstrumenter::kAgentDllCoverage;
39 : using CoverageInstrumenter::InstrumentPrepare;
40 : using CoverageInstrumenter::InstrumentImpl;
41 : using InstrumenterWithAgent::CreateRelinker;
42 : };
43 :
44 : class CoverageInstrumenterTest : public testing::PELibUnitTest {
45 : public:
46 : typedef testing::PELibUnitTest Super;
47 :
48 E : CoverageInstrumenterTest()
49 : : cmd_line_(base::FilePath(L"instrument.exe")) {
50 E : }
51 :
52 E : void SetUp() override {
53 E : testing::Test::SetUp();
54 :
55 : // Several of the tests generate progress and (deliberate) error messages
56 : // that would otherwise clutter the unittest output.
57 E : logging::SetMinLogLevel(logging::LOG_FATAL);
58 :
59 : // Setup the IO streams.
60 E : CreateTemporaryDir(&temp_dir_);
61 E : stdin_path_ = temp_dir_.Append(L"NUL");
62 E : stdout_path_ = temp_dir_.Append(L"stdout.txt");
63 E : stderr_path_ = temp_dir_.Append(L"stderr.txt");
64 E : InitStreams(stdin_path_, stdout_path_, stderr_path_);
65 :
66 : // Initialize the (potential) input and output path values.
67 E : abs_input_image_path_ = testing::GetExeRelativePath(testing::kTestDllName);
68 E : input_image_path_ = testing::GetRelativePath(abs_input_image_path_);
69 E : abs_input_pdb_path_ = testing::GetExeRelativePath(testing::kTestDllPdbName);
70 E : input_pdb_path_ = testing::GetRelativePath(abs_input_pdb_path_);
71 E : output_image_path_ = temp_dir_.Append(input_image_path_.BaseName());
72 E : output_pdb_path_ = temp_dir_.Append(input_pdb_path_.BaseName());
73 E : }
74 :
75 E : void SetUpValidCommandLine() {
76 E : cmd_line_.AppendSwitchPath("input-image", input_image_path_);
77 E : cmd_line_.AppendSwitchPath("output-image", output_image_path_);
78 E : }
79 :
80 : protected:
81 : base::FilePath temp_dir_;
82 :
83 : // @name The redirected streams paths.
84 : // @{
85 : base::FilePath stdin_path_;
86 : base::FilePath stdout_path_;
87 : base::FilePath stderr_path_;
88 : // @}
89 :
90 : // @name Command-line and parameters.
91 : // @{
92 : base::CommandLine cmd_line_;
93 : base::FilePath input_image_path_;
94 : base::FilePath input_pdb_path_;
95 : base::FilePath output_image_path_;
96 : base::FilePath output_pdb_path_;
97 : // @}
98 :
99 : // @name Expected final values of input parameters.
100 : // @{
101 : base::FilePath abs_input_image_path_;
102 : base::FilePath abs_input_pdb_path_;
103 : // @}
104 :
105 : // The fake instrumenter we delegate to.
106 : TestCoverageInstrumenter instrumenter_;
107 : };
108 :
109 : } // namespace
110 :
111 E : TEST_F(CoverageInstrumenterTest, ParseMinimalCoverage) {
112 E : SetUpValidCommandLine();
113 :
114 E : EXPECT_TRUE(instrumenter_.ParseCommandLine(&cmd_line_));
115 :
116 E : EXPECT_EQ(abs_input_image_path_, instrumenter_.input_image_path_);
117 E : EXPECT_EQ(output_image_path_, instrumenter_.output_image_path_);
118 : EXPECT_EQ(std::string(TestCoverageInstrumenter::kAgentDllCoverage),
119 E : instrumenter_.agent_dll_);
120 E : EXPECT_FALSE(instrumenter_.allow_overwrite_);
121 E : EXPECT_FALSE(instrumenter_.no_augment_pdb_);
122 E : EXPECT_FALSE(instrumenter_.no_strip_strings_);
123 E : EXPECT_FALSE(instrumenter_.debug_friendly_);
124 E : }
125 :
126 E : TEST_F(CoverageInstrumenterTest, ParseFullCoverage) {
127 E : SetUpValidCommandLine();
128 E : cmd_line_.AppendSwitchASCII("agent", "foo.dll");
129 E : cmd_line_.AppendSwitch("debug-friendly");
130 E : cmd_line_.AppendSwitchPath("input-pdb", input_pdb_path_);
131 E : cmd_line_.AppendSwitch("no-augment-pdb");
132 E : cmd_line_.AppendSwitch("no-strip-strings");
133 E : cmd_line_.AppendSwitchPath("output-pdb", output_pdb_path_);
134 E : cmd_line_.AppendSwitch("overwrite");
135 :
136 E : EXPECT_TRUE(instrumenter_.ParseCommandLine(&cmd_line_));
137 :
138 E : EXPECT_EQ(abs_input_image_path_, instrumenter_.input_image_path_);
139 E : EXPECT_EQ(output_image_path_, instrumenter_.output_image_path_);
140 E : EXPECT_EQ(abs_input_pdb_path_, instrumenter_.input_pdb_path_);
141 E : EXPECT_EQ(output_pdb_path_, instrumenter_.output_pdb_path_);
142 E : EXPECT_EQ(std::string("foo.dll"), instrumenter_.agent_dll_);
143 E : EXPECT_TRUE(instrumenter_.allow_overwrite_);
144 E : EXPECT_TRUE(instrumenter_.no_augment_pdb_);
145 E : EXPECT_TRUE(instrumenter_.no_strip_strings_);
146 E : EXPECT_TRUE(instrumenter_.debug_friendly_);
147 E : }
148 :
149 E : TEST_F(CoverageInstrumenterTest, InstrumentImpl) {
150 E : SetUpValidCommandLine();
151 :
152 E : EXPECT_TRUE(instrumenter_.ParseCommandLine(&cmd_line_));
153 E : EXPECT_TRUE(instrumenter_.InstrumentPrepare());
154 E : EXPECT_TRUE(instrumenter_.CreateRelinker());
155 E : EXPECT_TRUE(instrumenter_.InstrumentImpl());
156 E : }
157 :
158 : } // namespace instrumenters
159 : } // namespace instrument
|