Accountz-4.2 (#3393)

* Accountz-4.2

"This code is a Contribution to the OpenConfig Feature Profiles project ("Work") made under the Google Software Grant and Corporate Contributor License Agreement ("CLA") and governed by the Apache License 2.0. No other rights or licenses in or to any of Nokia's intellectual property are granted for any other purpose. This code is provided on an "as is" basis without any warranties of any kind."

* Fix comments

"This code is a Contribution to the OpenConfig Feature Profiles project ("Work") made under the Google Software Grant and Corporate Contributor License Agreement ("CLA") and governed by the Apache License 2.0. No other rights or licenses in or to any of Nokia's intellectual property are granted for any other purpose. This code is provided on an "as is" basis without any warranties of any kind."

feature/security/gnsi/acctz/README.md

@@ -37,7 +37,7 @@ Create a library of device configuration to be used for all of the gNSI.acctz.v1
 - [ACCTZ-2.1 Record Subscribe Partial](tests/record_subscribe_partial)
 - [ACCTZ-3.1 Record Subscribe Non-gRPC](RecordSubscribeNongrpc)
 - [ACCTZ-4.1 Record History Truncation](RecordHistoryTruncation/)
-- [ACCTZ-4.2 Record Payload Truncation](RecordPayloadTruncation/)
+- [ACCTZ-4.2 Record Payload Truncation](tests/record_payload_truncation)
 - [ACCTZ-5.1 Record Subscribe Idle Timeout](RecordSubscribeIdleTimeout/)
 - [ACCTZ-6.1 Record Subscribe Idle Timeout DoA](RecordSubscribeIdleTimeoutDoA/)
 - [ACCTZ-7.1 Accounting Authentication Failure - Multi-transaction](AccountingAuthenFailMulti/)

feature/security/gnsi/acctz/RecordPayloadTruncation/README.md → feature/security/gnsi/acctz/tests/record_payload_truncation/README.md

@@ -1,4 +1,4 @@
-# ACCTZ-4.2 - gNSI.acctz.v1 (Accounting) Test Record Payload Truncation
+# ACCTZ-4.2: Record Payload Truncation
 
 ## Summary
 

feature/security/gnsi/acctz/tests/record_payload_truncation/metadata.textproto

@@ -0,0 +1,8 @@
+# proto-file: github.com/openconfig/featureprofiles/proto/metadata.proto
+# proto-message: Metadata
+
+uuid:  "ae09edfd-f64e-4095-b56d-021ce29b659b"
+plan_id:  "ACCTZ-4.2"
+description:  "Record Payload Truncation"
+testbed:  TESTBED_DUT
+platform_exceptions:  {}

feature/security/gnsi/acctz/tests/record_payload_truncation/record_payload_truncation_test.go

@@ -0,0 +1,122 @@
+// 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.
+
+package record_payload_truncation_test
+
+import (
+	"context"
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/openconfig/featureprofiles/internal/fptest"
+	"github.com/openconfig/gnsi/acctz"
+	"github.com/openconfig/ondatra"
+	"github.com/openconfig/ondatra/gnmi"
+	"github.com/openconfig/ondatra/gnmi/oc"
+	"google.golang.org/protobuf/types/known/timestamppb"
+)
+
+func TestMain(m *testing.M) {
+	fptest.RunTests(m)
+}
+
+type recordRequestResult struct {
+	record *acctz.RecordResponse
+	err    error
+}
+
+func sendOversizedPayload(t *testing.T, dut *ondatra.DUTDevice) {
+	// Perhaps other vendors will need a different payload/size/etc., for now we'll just send a
+	// giant set of network instances + static routes which should hopefully work for everyone.
+	ocRoot := &oc.Root{}
+
+	for i := 0; i < 50; i++ {
+		ni := ocRoot.GetOrCreateNetworkInstance(fmt.Sprintf("acctz-test-ni-%d", i))
+		ni.SetDescription("This is a pointlessly long description in order to make the payload bigger.")
+		ni.SetType(oc.NetworkInstanceTypes_NETWORK_INSTANCE_TYPE_L3VRF)
+		staticProtocol := ni.GetOrCreateProtocol(oc.PolicyTypes_INSTALL_PROTOCOL_TYPE_STATIC, "static")
+		for j := 0; j < 254; j++ {
+			staticProtocol.GetOrCreateStatic(fmt.Sprintf("10.%d.0.0/24", j))
+		}
+	}
+
+	gnmi.Update(t, dut, gnmi.OC().Config(), ocRoot)
+}
+
+func TestAccountzRecordPayloadTruncation(t *testing.T) {
+	dut := ondatra.DUT(t, "dut")
+	startTime := time.Now()
+	sendOversizedPayload(t, dut)
+	acctzClient := dut.RawAPIs().GNSI(t).Acctz()
+
+	acctzSubClient, err := acctzClient.RecordSubscribe(context.Background())
+	if err != nil {
+		t.Fatalf("Failed getting accountz record subscribe client, error: %s", err)
+	}
+
+	err = acctzSubClient.Send(&acctz.RecordRequest{
+		Timestamp: timestamppb.New(startTime),
+	})
+	if err != nil {
+		t.Fatalf("Failed sending record request, error: %s", err)
+	}
+
+	for {
+		r := make(chan recordRequestResult)
+
+		go func(r chan recordRequestResult) {
+			var response *acctz.RecordResponse
+			response, err = acctzSubClient.Recv()
+			r <- recordRequestResult{
+				record: response,
+				err:    err,
+			}
+		}(r)
+
+		var done bool
+		var resp recordRequestResult
+
+		select {
+		case rr := <-r:
+			resp = rr
+		case <-time.After(10 * time.Second):
+			done = true
+		}
+
+		if done {
+			t.Fatal("Done receiving records and did not find our record...")
+		}
+
+		if resp.err != nil {
+			t.Fatalf("Failed receiving record response, error: %s", resp.err)
+		}
+
+		grpcServiceRecord := resp.record.GetGrpcService()
+
+		if grpcServiceRecord.GetServiceType() != acctz.GrpcService_GRPC_SERVICE_TYPE_GNMI {
+			// Not our gnmi set, nothing to see here.
+			continue
+		}
+
+		if grpcServiceRecord.RpcName != "/gnmi.gNMI/Set" {
+			continue
+		}
+
+		if grpcServiceRecord.GetPayloadIstruncated() {
+			t.Log("Found truncated payload of gnmi.Set after start timestamp, success!")
+			break
+		}
+	}
+}