[Courgette] Refactor: Add CourgetteFlow; improve courgette_tool.cc help text.

courgette/encoded_program_fuzz_unittest.cc

 // Copyright (c) 2011 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.
 
 // Fuzz testing for EncodedProgram serialized format and assembly.
 //
 // We would like some assurance that if an EncodedProgram is malformed we will
 // not crash.  The EncodedProgram could be malformed either due to malicious
 // attack to due to an error in patch generation.
 //
 // We try a lot of arbitrary modifications to the serialized form and make sure
 // that the outcome is not a crash.
 #include "courgette/encoded_program.h"
 
 #include <stddef.h>
 
 #include <memory>
 
 #include "base/test/test_suite.h"
-#include "courgette/assembly_program.h"
 #include "courgette/base_test_unittest.h"
 #include "courgette/courgette.h"
-#include "courgette/program_detector.h"
+#include "courgette/courgette_flow.h"
 #include "courgette/streams.h"
 
 class DecodeFuzzTest : public BaseTest {
  public:
   void FuzzExe(const char *) const;
 
  private:
   void FuzzByte(const std::string& buffer, const std::string& output,
                 size_t index) const;
   void FuzzBits(const std::string& buffer, const std::string& output,
                 size_t index, int bits_to_flip) const;
 
   // Returns true if could assemble, false if rejected.
   bool TryAssemble(const std::string& buffer, std::string* output) const;
 };
 
 // Loads an executable and does fuzz testing in the serialized format.
 void DecodeFuzzTest::FuzzExe(const char* file_name) const {
   std::string file1 = FileContents(file_name);
 
-  const uint8_t* original_buffer =
-      reinterpret_cast<const uint8_t*>(file1.data());
+  const uint8_t* original_data = reinterpret_cast<const uint8_t*>(file1.data());
   size_t original_length = file1.length();
+  courgette::CourgetteFlow flow;
 
-  std::unique_ptr<courgette::AssemblyProgram> program;
-  const courgette::Status parse_status =
-      courgette::ParseDetectedExecutable(original_buffer, original_length,
-                                         &program);
-  EXPECT_EQ(courgette::C_OK, parse_status);
+  courgette::RegionBuffer original_buffer(
+      courgette::Region(original_data, original_length));
+  flow.ReadAssemblyProgramFromBuffer(flow.ONLY, original_buffer, false);
+  EXPECT_EQ(courgette::C_OK, flow.status());
+  EXPECT_TRUE(nullptr != flow.data(flow.ONLY)->program.get());
 
-  std::unique_ptr<courgette::EncodedProgram> encoded;
-  const courgette::Status encode_status = Encode(*program, &encoded);
-  EXPECT_EQ(courgette::C_OK, encode_status);
+  flow.CreateEncodedProgramFromAssemblyProgram(flow.ONLY);
+  EXPECT_EQ(courgette::C_OK, flow.status());
+  EXPECT_TRUE(nullptr != flow.data(flow.ONLY)->encoded.get());
 
-  program.reset();
+  flow.DestroyAssemblyProgram(flow.ONLY);
+  EXPECT_EQ(courgette::C_OK, flow.status());
+  EXPECT_TRUE(nullptr == flow.data(flow.ONLY)->program.get());
 
-  courgette::SinkStreamSet sinks;
-  const courgette::Status write_status =
-      WriteEncodedProgram(encoded.get(), &sinks);
-  EXPECT_EQ(courgette::C_OK, write_status);
+  flow.WriteSinkStreamSetFromEncodedProgram(flow.ONLY);
+  EXPECT_EQ(courgette::C_OK, flow.status());
 
-  encoded.reset();
+  flow.DestroyEncodedProgram(flow.ONLY);
+  EXPECT_EQ(courgette::C_OK, flow.status());
+  EXPECT_TRUE(nullptr == flow.data(flow.ONLY)->encoded.get());
 
   courgette::SinkStream sink;
-  bool can_collect = sinks.CopyTo(&sink);
-  EXPECT_TRUE(can_collect);
+  flow.WriteSinkStreamFromSinkStreamSet(flow.ONLY, &sink);
+  EXPECT_EQ(courgette::C_OK, flow.status());
+  EXPECT_TRUE(flow.ok());
+  EXPECT_FALSE(flow.failed());
 
   size_t length = sink.Length();
 
   std::string base_buffer(reinterpret_cast<const char*>(sink.Buffer()), length);
   std::string base_output;
   bool ok = TryAssemble(base_buffer, &base_output);
   EXPECT_TRUE(ok);
 
   // Now we have a good serialized EncodedProgram in |base_buffer|. Time to
   // fuzz.
@@ skipping 86 matching lines @@
     }
 
     if (index > 60) {                     // Beyond the origin addresses ...
       EXPECT_NE(0U, changed_byte_count);   //   ... we expect some difference.
     }
     // Currently all changes are smaller than this number:
     EXPECT_GE(45000U, changed_byte_count);
   }
 }
 
-bool DecodeFuzzTest::TryAssemble(const std::string& buffer,
+bool DecodeFuzzTest::TryAssemble(const std::string& file,
                                  std::string* output) const {
-  std::unique_ptr<courgette::EncodedProgram> encoded;
-  bool result = false;
+  courgette::CourgetteFlow flow;
+  courgette::RegionBuffer file_buffer(courgette::Region(
+      reinterpret_cast<const uint8_t*>(file.data()), file.length()));
+  flow.ReadSourceStreamSetFromBuffer(flow.ONLY, file_buffer);
+  if (flow.failed())
+    return false;
 
-  courgette::SourceStreamSet sources;
-  bool can_get_source_streams = sources.Init(buffer.c_str(), buffer.length());
-  if (can_get_source_streams) {
-    const courgette::Status read_status =
-        ReadEncodedProgram(&sources, &encoded);
-    if (read_status == courgette::C_OK) {
-      courgette::SinkStream assembled;
-      const courgette::Status assemble_status =
-          Assemble(encoded.get(), &assembled);
+  flow.ReadEncodedProgramFromSourceStreamSet(flow.ONLY);
+  if (flow.failed())
+    return false;
 
-      if (assemble_status == courgette::C_OK) {
-        const void* assembled_buffer = assembled.Buffer();
-        size_t assembled_length = assembled.Length();
+  courgette::SinkStream sink;
+  flow.WriteExecutableFromEncodedProgram(flow.ONLY, &sink);
+  if (flow.failed())
+    return false;
 
-        output->clear();
-        output->assign(reinterpret_cast<const char*>(assembled_buffer),
-                       assembled_length);
-        result = true;
-      }
-    }
-  }
-
-  return result;
+  output->clear();
+  output->assign(reinterpret_cast<const char*>(sink.Buffer()), sink.Length());
+  return true;
 }
 
 TEST_F(DecodeFuzzTest, All) {
   FuzzExe("setup1.exe");
   FuzzExe("elf-32-1.exe");
 }
 
 int main(int argc, char** argv) {
   return base::TestSuite(argc, argv).Run();
 }