protobuf.h

/*
 * SPDX-FileCopyrightText: 2023 Google LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_BMV2_TEST_BACKEND_PROTOBUF_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_BMV2_TEST_BACKEND_PROTOBUF_H_
 
#include <cstddef>
#include <optional>
#include <string>
#include <vector>
 
#include <inja/inja.hpp>
 
#include "backends/p4tools/common/control_plane/p4info_map.h"
#include "control-plane/p4RuntimeSerializer.h"
#include "ir/ir.h"
#include "lib/cstring.h"
 
#include "backends/p4tools/modules/testgen/lib/test_spec.h"
#include "backends/p4tools/modules/testgen/targets/bmv2/test_backend/common.h"
 
namespace P4::P4Tools::P4Testgen::Bmv2 {
 
using P4::ControlPlaneAPI::p4rt_id_t;
 
struct ProtobufTest : public AbstractTest {
 private:
    std::string formattedTest_;
 
 public:
    explicit ProtobufTest(std::string formattedTest) : formattedTest_(std::move(formattedTest)) {}

    [[nodiscard]] const std::string &getFormattedTest() const { return formattedTest_; }
 
    DECLARE_TYPEINFO(ProtobufTest);
};

class Protobuf : public Bmv2TestFramework {
 public:
    explicit Protobuf(const TestBackendConfiguration &testBackendConfiguration,
                      P4::P4RuntimeAPI p4RuntimeApi);
 
    void writeTestToFile(const TestSpec *testSpec, cstring selectedBranches, size_t testId,
                         float currentCoverage) override;
 
    AbstractTestReferenceOrError produceTest(const TestSpec *testSpec, cstring selectedBranches,
                                             size_t testIdx, float currentCoverage) override;
 
 private:
    P4::P4RuntimeAPI p4RuntimeApi;

    P4::ControlPlaneAPI::P4InfoMaps p4InfoMaps;
 
    inja::json getControlPlane(const TestSpec *testSpec) const override;
 
    [[nodiscard]] inja::json getSend(const TestSpec *testSpec) const override;
 
    [[nodiscard]] inja::json getExpectedPacket(const TestSpec *testSpec) const override;

    static std::string formatHexExprWithSep(const IR::Expression *expr);

    [[nodiscard]] std::optional<p4rt_id_t> lookupP4RuntimeId(cstring controlPlaneName) const;

    void emitPreamble(const std::string &preamble);

    inja::json produceTestCase(const TestSpec *testSpec, cstring selectedBranches, size_t testId,
                               float currentCoverage) const;

    static std::string getTestCaseTemplate();

    [[nodiscard]] inja::json getControlPlaneForTable(cstring tableName, cstring actionName,
                                                     const TableMatchMap &matches,
                                                     const std::vector<ActionArg> &args) const;
};
 
}  // namespace P4::P4Tools::P4Testgen::Bmv2
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_BMV2_TEST_BACKEND_PROTOBUF_H_ */