[Thinkit] Implement the various component validators for PINs NSF tes…

…ts.Update NsfTestParam types and names for better usability.Create utility functions for NSF integration tests.Test 35 (sonic-net#936)

* [Thinkit] Implement the various flow programmers for PINs NSF tests.

PiperOrigin-RevId: 596809160

* [Thinkit] Implement the various component validators for PINs NSF tests.Update NsfTestParam types and names for better usability.Create utility functions for NSF integration tests.

---------

Co-authored-by: kishanps <[email protected]>

tests/integration/system/nsf/BUILD.bazel

@@ -0,0 +1,36 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This package has the integration tests along with the utilities for testing NSF in PINs.
+
+package(
+    default_visibility = ["//visibility:public"],
+    licenses = ["notice"],
+)
+
+cc_library(
+    name = "util",
+    testonly = True,
+    srcs = ["util.cc"],
+    hdrs = ["util.h"],
+    deps = [
+        "//gutil:status",
+        "//tests/integration/system/nsf/interfaces:component_validator",
+        "//thinkit:generic_testbed",
+        "@com_github_p4lang_p4runtime//:p4info_cc_proto",
+        "@com_google_absl//absl/status",
+        "@com_google_absl//absl/strings:string_view",
+        "@com_google_absl//absl/types:span",
+    ],
+)

tests/integration/system/nsf/component_validators/BUILD.bazel

@@ -0,0 +1,63 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This package implements the various component validators for PINs NSF tests.
+#
+# Note: These are dummy validators added as example of ComponentValidators implementation.
+# Component owners need to have their own implementations and register to be used by the NSF Upgrade
+# tests.
+
+package(
+    default_visibility = ["//visibility:public"],
+    licenses = ["notice"],
+)
+
+cc_library(
+    name = "sai_validator",
+    testonly = True,
+    hdrs = ["sai_validator.h"],
+    deps = [
+        "//tests/integration/system/nsf/interfaces:component_validator",
+        "//thinkit:generic_testbed",
+        "@com_github_google_glog//:glog",
+        "@com_google_absl//absl/status",
+        "@com_google_absl//absl/strings:string_view",
+    ],
+)
+
+cc_library(
+    name = "swss_validator",
+    testonly = True,
+    hdrs = ["swss_validator.h"],
+    deps = [
+        "//tests/integration/system/nsf/interfaces:component_validator",
+        "//thinkit:generic_testbed",
+        "@com_github_google_glog//:glog",
+        "@com_google_absl//absl/status",
+        "@com_google_absl//absl/strings:string_view",
+    ],
+)
+
+cc_library(
+    name = "syncd_validator",
+    testonly = True,
+    hdrs = ["syncd_validator.h"],
+    deps = [
+        "//tests/integration/system/nsf/interfaces:component_validator",
+        "//thinkit:generic_testbed",
+        "@com_github_google_glog//:glog",
+        "@com_google_absl//absl/status",
+        "@com_google_absl//absl/strings:string_view",
+    ],
+)

tests/integration/system/nsf/component_validators/sai_validator.h

@@ -0,0 +1,44 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SAI_VALIDATOR_H_
+#define PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SAI_VALIDATOR_H_
+
+#include "absl/status/status.h"
+#include "absl/strings/string_view.h"
+#include "glog/logging.h"
+#include "tests/integration/system/nsf/interfaces/component_validator.h"
+#include "thinkit/generic_testbed.h"
+
+namespace pins_test {
+
+// Dummy validators added as example of ComponentValidators implementation.
+// Component owners need to have their own implementations and register to be
+// used by the NSF Upgrade tests.
+class SaiValidator : public ComponentValidator {
+  absl::Status OnInit(absl::string_view version,
+                      thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Sai Init";
+    return absl::OkStatus();
+  }
+  absl::Status OnFlowCleanup(absl::string_view version,
+                             thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Sai Flow Cleanup";
+    return absl::OkStatus();
+  }
+};
+
+}  // namespace pins_test
+
+#endif  // PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SAI_VALIDATOR_H_

tests/integration/system/nsf/component_validators/swss_validator.h

@@ -0,0 +1,44 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SWSS_VALIDATOR_H_
+#define PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SWSS_VALIDATOR_H_
+
+#include "absl/status/status.h"
+#include "absl/strings/string_view.h"
+#include "glog/logging.h"
+#include "tests/integration/system/nsf/interfaces/component_validator.h"
+#include "thinkit/generic_testbed.h"
+
+namespace pins_test {
+
+// Dummy validators added as example of ComponentValidators implementation.
+// Component owners need to have their own implementations and register to be
+// used by the NSF Upgrade tests.
+class SwssValidator : public ComponentValidator {
+  absl::Status OnInit(absl::string_view version,
+                      thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Swss Init";
+    return absl::OkStatus();
+  }
+  absl::Status OnFlowProgram(absl::string_view version,
+                             thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Swss Flow Program";
+    return absl::OkStatus();
+  }
+};
+
+}  // namespace pins_test
+
+#endif  // PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SWSS_VALIDATOR_H_

tests/integration/system/nsf/component_validators/syncd_validator.h

@@ -0,0 +1,49 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SYNCD_VALIDATOR_H_
+#define PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SYNCD_VALIDATOR_H_
+
+#include "absl/status/status.h"
+#include "absl/strings/string_view.h"
+#include "glog/logging.h"
+#include "tests/integration/system/nsf/interfaces/component_validator.h"
+#include "thinkit/generic_testbed.h"
+
+namespace pins_test {
+
+// Dummy validators added as example of ComponentValidators implementation.
+// Component owners need to have their own implementations and register to be
+// used by the NSF Upgrade tests.
+class SyncdValidator : public ComponentValidator {
+  absl::Status OnInit(absl::string_view version,
+                      thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Syncd Init";
+    return absl::OkStatus();
+  }
+  absl::Status OnFlowProgram(absl::string_view version,
+                             thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Syncd Flow Program";
+    return absl::OkStatus();
+  }
+  absl::Status OnFlowCleanup(absl::string_view version,
+                             thinkit::GenericTestbed& testbed) override {
+    LOG(INFO) << "Syncd Flow Cleanup";
+    return absl::OkStatus();
+  }
+};
+
+}  // namespace pins_test
+
+#endif  // PINS_TESTS_INTEGRATION_SYSTEM_NSF_COMPONENT_VALIDATORS_SYNCD_VALIDATOR_H_

tests/integration/system/nsf/interfaces/BUILD.bazel

@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     https://www.apache.org/licenses/LICENSE-2.0
+#      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

tests/integration/system/nsf/interfaces/test_params.h

@@ -15,6 +15,8 @@
 #ifndef PINS_TESTS_INTEGRATION_SYSTEM_NSF_INTERFACES_TEST_PARAMS_H_
 #define PINS_TESTS_INTEGRATION_SYSTEM_NSF_INTERFACES_TEST_PARAMS_H_
 
+#include <functional>
+#include <memory>
 #include <string>
 #include <vector>
 
@@ -31,10 +33,12 @@ namespace pins_test {
 // parameterized NSF integration test.
 struct NsfTestParams {
   std::string name;
-  FlowProgrammer* flow_programmer;
-  TrafficHelper* traffic_helper;
-  thinkit::GenericTestbedInterface* testbed_interface;
-  std::vector<ComponentValidator*> component_validators;
+  std::function<std::unique_ptr<FlowProgrammer>()> create_flow_programmer;
+  std::function<std::unique_ptr<TrafficHelper>()> create_traffic_helper;
+  std::function<std::unique_ptr<thinkit::GenericTestbedInterface>()>
+      create_testbed_interface;
+  std::function<std::vector<std::unique_ptr<ComponentValidator>>()>
+      create_component_validators;
 };
 
 }  // namespace pins_test

tests/integration/system/nsf/traffic_helpers/BUILD.bazel

@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     https://www.apache.org/licenses/LICENSE-2.0
+#      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

tests/integration/system/nsf/traffic_helpers/otg_helper.h

@@ -22,8 +22,6 @@
 namespace pins_test {
 
 class OtgHelper : public TrafficHelper {
-  ~OtgHelper() override = default;
-
  public:
   absl::Status StartTraffic(thinkit::GenericTestbed& testbed) override {
     return absl::OkStatus();

tests/integration/system/nsf/util.cc

@@ -0,0 +1,68 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "tests/integration/system/nsf/util.h"
+
+#include <functional>
+#include <memory>
+
+#include "absl/status/status.h"
+#include "absl/strings/string_view.h"
+#include "absl/types/span.h"
+#include "gutil/status.h"  // NOLINT: Need to add gutil/status.h for using `RETURN_IF_ERROR` in upstream code.
+#include "p4/config/v1/p4info.pb.h"
+#include "tests/integration/system/nsf/interfaces/component_validator.h"
+#include "thinkit/generic_testbed.h"
+
+namespace pins_test {
+
+using p4::v1::ReadResponse;
+
+absl::Status InstallRebootPushConfig(absl::string_view version) {
+  return absl::OkStatus();
+}
+
+absl::Status ValidateSwitchState(absl::string_view version) {
+  return absl::OkStatus();
+}
+
+absl::Status ValidateComponents(
+    absl::Status (ComponentValidator::*validate)(absl::string_view,
+                                                 thinkit::GenericTestbed&),
+    const absl::Span<const std::unique_ptr<ComponentValidator>> validators,
+    absl::string_view version, thinkit::GenericTestbed& testbed) {
+  for (const std::unique_ptr<ComponentValidator>& validator : validators) {
+    RETURN_IF_ERROR((std::invoke(validate, validator, version, testbed)));
+  }
+  return absl::OkStatus();
+}
+
+absl::Status Upgrade(absl::string_view version) { return absl::OkStatus(); }
+
+absl::Status NsfReboot(absl::string_view version) { return absl::OkStatus(); }
+
+absl::Status PushConfig(absl::string_view version) { return absl::OkStatus(); }
+
+ReadResponse TakeP4FlowSnapshot() { return ReadResponse(); }
+
+absl::Status CompareP4FlowSnapshots(const ReadResponse& a,
+                                    const ReadResponse& b) {
+  return absl::OkStatus();
+}
+
+absl::Status CaptureDbState() { return absl::OkStatus(); }
+
+absl::Status ValidateDbState() { return absl::OkStatus(); }
+
+}  // namespace pins_test