[realm][fuzzing] Clean up manifests and shards

This CL streamlines the component manifests and manifest shard files
used by realmfuzzer. It removes extraneous definitions and deduplicates
as much as possible.

Change-Id: Ifa859150dc95106ea1a2cf0956b305ecdf44c203
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/907727
Reviewed-by: Dzmitry Yatsushkevich <[email protected]>
Commit-Queue: Aaron Green <[email protected]>

Author: nopsledder

src/sys/fuzzing/realmfuzzer/adapters/llvm.shard.cml

@@ -4,22 +4,33 @@
 
 // This manifest shard corresponds to the fuzz target adapter component, which
 // maps test inputs from the engine to the target component(s) being fuzzed.
+//
+// To create a realm fuzzer adapter component, include this shard and specify
+// the program name, arguments, and capability routes.
+//
+// Example:
+//    {
+//        include: [ "//src/sys/fuzzing/realmfuzzer/adapter/llvm.shard.cml" ],
+//        program: {
+//            name: "adapter",
+//        },
+//        use: [
+//            { protocol: "foo.bar.Baz" },
+//        ],
+//    }
+//
+// See also //src/sys/fuzzing/realmfuzzer/fuzzer.shard.cml.
 {
-    include: [
-        "//sdk/lib/inspect/client.shard.cml",
-        "syslog/client.shard.cml",
-    ],
+    include: [ "//src/sys/fuzzing/realmfuzzer/target/default.shard.cml" ],
     program: {
         runner: "elf",
     },
     capabilities: [
-        {
-            protocol: [ "fuchsia.fuzzer.TargetAdapter" ],
-        },
+        { protocol: "fuchsia.fuzzer.TargetAdapter" },
     ],
     expose: [
         {
-            protocol: [ "fuchsia.fuzzer.TargetAdapter" ],
+            protocol: "fuchsia.fuzzer.TargetAdapter",
             from: "self",
         },
     ],

src/sys/fuzzing/realmfuzzer/coverage/tests/meta/adapter.cml

@@ -2,24 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 {
-    include: [ "syslog/client.shard.cml" ],
+    include: [ "//src/sys/fuzzing/realmfuzzer/adapters/llvm.shard.cml" ],
     program: {
-        runner: "elf",
         binary: "bin/realmfuzzer_coverage_test_adapter",
     },
-    capabilities: [
-        { protocol: "fuchsia.fuzzer.TargetAdapter" },
-    ],
-    use: [
-        {
-            protocol: "fuchsia.fuzzer.CoverageDataCollector",
-            from: "debug",
-        },
-    ],
-    expose: [
-        {
-            protocol: "fuchsia.fuzzer.TargetAdapter",
-            from: "self",
-        },
-    ],
 }

src/sys/fuzzing/realmfuzzer/engine/default.shard.cml

@@ -2,30 +2,35 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// This manifest shard corresponds to both the "real" and "test" engines used in
-// fuzzers and fuzzer tests, respectively.
+// This manifest shard provides the portions of the engine component description
+// shared between both the fuzzing engine and the integration tests.
 {
     include: [
-        "//sdk/lib/inspect/client.shard.cml",
+        "inspect/client.shard.cml",
         "syslog/client.shard.cml",
     ],
     children: [
         {
-            name: "fuzzer",
-            url: "#meta/fuzzer.cm",
+            name: "coverage",
+            url: "#meta/coverage.cm",
         },
     ],
     use: [
         {
             protocol: "fuchsia.fuzzer.TargetAdapter",
-            from: "#fuzzer",
+            from: "#adapter",
         },
+        {
+            protocol: "fuchsia.fuzzer.CoverageDataProvider",
+            from: "#coverage",
+        },
+        { protocol: "fuchsia.process.Launcher" },
     ],
     offer: [
         {
             protocol: [ "fuchsia.process.Launcher" ],
             from: "parent",
-            to: "#fuzzer",
+            to: "#adapter",
         },
     ],
 }

src/sys/fuzzing/realmfuzzer/engine/meta/engine.cml

@@ -0,0 +1,32 @@
+// Copyright 2022 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// This manifest corresponds to a realm fuzzing engine component.
+//
+// To create a realm fuzzer engine component manifest file, include this shard
+// and define a child named "adapter" that uses the "fuzzed-env" environment.
+//
+// Example:
+//    {
+//        include: [ "//src/sys/fuzzing/realmfuzzer/fuzzer.shard.cml" ],
+//        children: [
+//            {
+//                name: "adapter",
+//                url: "#meta/foo_fuzz_adapter.cm",
+//                environment: "#fuzzed-env",
+//            },
+//        ],
+//    }
+//
+// See also //src/sys/fuzzing/realmfuzzer/adapters/llvm.shard.cml.
+{
+    include: [
+        "//src/sys/fuzzing/realmfuzzer/coverage/fuzzed-env.shard.cml",
+        "//src/sys/fuzzing/realmfuzzer/engine/default.shard.cml",
+        "//src/sys/test_runners/fuzz/default.shard.cml",
+    ],
+    program: {
+        binary: "bin/realmfuzzer_engine",
+    },
+}

src/sys/fuzzing/realmfuzzer/fuzzer.shard.cml

@@ -5,6 +5,10 @@
 // This manifest shard corresponds to a component being fuzzed, which produces
 // coverage data as a result of actions taken by the adapter component.
 {
+    include: [
+        "inspect/client.shard.cml",
+        "syslog/client.shard.cml",
+    ],
     use: [
         {
             protocol: "fuchsia.fuzzer.CoverageDataCollector",

src/sys/fuzzing/realmfuzzer/target/default.shard.cml

@@ -14,7 +14,7 @@ group("tests") {
   ]
 }
 
-executable("fuzzer-bin") {
+executable("adapter") {
   testonly = true
   output_name = "realmfuzzer_test_fuzzer"
   deps = [
@@ -26,10 +26,11 @@ executable("fuzzer-bin") {
   exclude_toolchain_tags = [ "instrumented" ]
 }
 
-fuchsia_test_component("fuzzer") {
-  manifest = "meta/fuzzer.cml"
+fuchsia_test_component("adapter-component") {
+  component_name = "adapter"
+  manifest = "meta/adapter.cml"
   deps = [
-    ":fuzzer-bin",
+    ":adapter",
     "//src/sys/fuzzing/common/testing/data:corpus",
   ]
 }
@@ -56,7 +57,7 @@ fuchsia_test_package("integration-tests-pkg") {
   package_name = "realmfuzzer-integration-tests"
   test_components = [ ":integration-tests" ]
   deps = [
-    ":fuzzer",
+    ":adapter-component",
     "//src/sys/fuzzing/realmfuzzer/coverage",
   ]
 }

src/sys/fuzzing/realmfuzzer/tests/BUILD.gn

@@ -1,19 +1,10 @@
 // Copyright 2022 The Fuchsia Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-
-// This manifest corresponds to the fuzzer used by the integration tests.
 {
     include: [ "//src/sys/fuzzing/realmfuzzer/adapters/llvm.shard.cml" ],
     program: {
-        runner: "elf",
         binary: "bin/realmfuzzer_test_fuzzer",
         args: [ "data/corpus" ],
     },
-    use: [
-        {
-            protocol: "fuchsia.fuzzer.CoverageDataCollector",
-            from: "debug",
-        },
-    ],
 }

src/sys/fuzzing/realmfuzzer/tests/meta/fuzzer.cml renamed to src/sys/fuzzing/realmfuzzer/tests/meta/adapter.cml

@@ -6,52 +6,18 @@
 // tests.
 {
     include: [
-        "//sdk/lib/inspect/client.shard.cml",
         "//src/sys/fuzzing/realmfuzzer/coverage/fuzzed-env.shard.cml",
+        "//src/sys/fuzzing/realmfuzzer/engine/default.shard.cml",
         "//src/sys/test_runners/gtest/default.shard.cml",
-        "inspect/offer.shard.cml",
-        "syslog/client.shard.cml",
     ],
     program: {
         binary: "test/realmfuzzer_integration_tests",
     },
     children: [
         {
-            name: "coverage",
-            url: "#meta/coverage.cm",
-        },
-        {
-            name: "engine",
-            url: "#meta/engine.cm",
-        },
-        {
-            name: "fuzzer",
-            url: "#meta/fuzzer.cm",
+            name: "adapter",
+            url: "#meta/adapter.cm",
             environment: "#fuzzed-env",
         },
     ],
-    use: [
-        {
-            protocol: "fuchsia.fuzzer.TargetAdapter",
-            from: "#fuzzer",
-        },
-        {
-            protocol: "fuchsia.fuzzer.CoverageDataProvider",
-            from: "#coverage",
-        },
-        {
-            protocol: [ "fuchsia.process.Launcher" ],
-            from: "parent",
-        },
-    ],
-    offer: [
-        {
-            protocol: [ "fuchsia.process.Launcher" ],
-            from: "parent",
-            to: [
-                "#coverage",
-                "#fuzzer",
-            ],
-        },
-    ],
 }