protobuf_ir.h

/*
 * SPDX-FileCopyrightText: 2023 Google LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_BMV2_TEST_BACKEND_PROTOBUF_IR_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_BMV2_TEST_BACKEND_PROTOBUF_IR_H_
 
#include <cstddef>
#include <string>
#include <utility>
 
#include <inja/inja.hpp>
 
#include "control-plane/p4RuntimeSerializer.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 {
 
struct ProtobufIrTest : public AbstractTest {
 private:
    std::string formattedTest_;
 
 public:
    explicit ProtobufIrTest(std::string formattedTest) : formattedTest_(std::move(formattedTest)) {}

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

class ProtobufIr : public Bmv2TestFramework {
 public:
    explicit ProtobufIr(const TestBackendConfiguration &testBackendConfiguration,
                        P4::P4RuntimeAPI p4RuntimeApi);
 
    ~ProtobufIr() override = default;
    ProtobufIr(const ProtobufIr &) = default;
    ProtobufIr(ProtobufIr &&) = default;
    ProtobufIr &operator=(const ProtobufIr &) = default;
    ProtobufIr &operator=(ProtobufIr &&) = default;
 
    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;
 
    [[nodiscard]] inja::json getControlPlaneTable(const TableConfig &tblConfig) const override;
 
    [[nodiscard]] inja::json getControlPlaneForTable(
        const TableMatchMap &matches, const std::vector<ActionArg> &args) const override;
 
    [[nodiscard]] inja::json getSend(const TestSpec *testSpec) const override;
 
    [[nodiscard]] inja::json getExpectedPacket(const TestSpec *testSpec) const override;

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

    static std::string getTestCaseTemplate();

    static std::optional<std::string> checkForP4RuntimeTranslationAnnotation(
        const IR::IAnnotated *node);

    static std::map<cstring, cstring> getP4RuntimeTranslationMappings(const IR::IAnnotated *node);

    static std::string getFormatOfNode(const IR::IAnnotated *node);

    static std::string formatNetworkValue(const std::string &type, const IR::Expression *value);

    static std::string formatNetworkValue(const IR::IAnnotated *node, const std::string &type,
                                          const IR::Expression *value);

    static void createKeyMatch(cstring fieldName, const TableMatch &fieldMatch,
                               inja::json &rulesJson);
};
 
}  // namespace P4::P4Tools::P4Testgen::Bmv2
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_TARGETS_BMV2_TEST_BACKEND_PROTOBUF_IR_H_ */