backends/p4tools/modules/testgen/options.h

/*
 * SPDX-FileCopyrightText: 2022 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_MODULES_TESTGEN_OPTIONS_H_
#define BACKENDS_P4TOOLS_MODULES_TESTGEN_OPTIONS_H_
 
#include <cstdint>
#include <filesystem>
#include <optional>
#include <set>
#include <string>
 
#include "backends/p4tools/common/options.h"
#include "lib/cstring.h"
#include "midend/coverage.h"
 
#include "backends/p4tools/modules/testgen/core/symbolic_executor/path_selection.h"
 
namespace P4::P4Tools::P4Testgen {

class TestgenOptions : public AbstractP4cToolOptions {
 public:
    TestgenOptions();
    virtual ~TestgenOptions() = default;

    int64_t maxTests = 1;

    P4Testgen::PathSelectionPolicy pathSelectionPolicy = P4Testgen::PathSelectionPolicy::DepthFirst;

    static const std::set<cstring> SUPPORTED_STOP_METRICS;
 
    // Stops generating tests when a particular metric is satisfied. Currently supported options are
    // listed in @var SUPPORTED_STOP_METRICS.
    cstring stopMetric;

    static TestgenOptions &get();

    std::optional<std::filesystem::path> outputDir = std::nullopt;

    bool strict = false;

    cstring testBackend;

    std::string selectedBranches;

    std::string pattern;

    bool trackBranches = false;

    bool dcg = false;

    // The default is the standard MTU, 1500 bytes.
    int maxPktSize = 12000;

    int minPktSize = 0;

    std::vector<std::pair<int, int>> permittedPortRanges;

    std::set<cstring> skippedControlPlaneEntities;

    bool outputPacketOnly = false;

    bool droppedPacketOnly = false;

    bool enforceAssumptions = true;

    bool assertionModeEnabled = false;

    P4::Coverage::CoverageOptions coverageOptions;

    bool hasCoverageTracking = false;

    float minCoverage = 0;

    std::optional<cstring> testBaseName;
 
 protected:
    bool validateOptions() const override;
};
 
}  // namespace P4::P4Tools::P4Testgen
 
#endif /* BACKENDS_P4TOOLS_MODULES_TESTGEN_OPTIONS_H_ */