src/diagnostics/sampler/testing/fidl/realm_factory.test.fidl

// Copyright 2023 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.

library test.sampler;

using fuchsia.component.sandbox;
using fuchsia.testing.harness;

/// RealmOptions tells the RealmFactory protocol how to create the test realm.
type RealmOptions = resource table {
    /// Optional name to give to the Sampler realm component.
    /// Defaults to "sampler".
    1: sampler_component_name string;
    /// Optional name to give to the "Single Counter" realm component.
    /// Defaults to "single_counter".
    2: single_counter_name string;
    /// Optional name to give to the mock Cobalt realm component.
    /// Defaults to "mock_cobalt".
    3: mock_cobalt_name string;
    /// Optional name to give to the Archivist realm component.
    /// Defaults to "test_case_archivist".
    4: test_archivist_name string;
};

@discoverable
open protocol RealmFactory {
    /// Specifies the options to use when creating the realm.
    ///
    /// Returns OperationError.INVALID if called more than once.
    flexible CreateRealm(resource struct {
        options RealmOptions;
        dictionary server_end:fuchsia.component.sandbox.Dictionary;
    }) -> () error fuchsia.testing.harness.OperationError;
};