ICMP Extensions YANG Model (RFC 5837)

.github/CODEOWNERS

@@ -16,22 +16,24 @@
 /feature/bgp/          @openconfig/featureprofiles-owner-bgp
 /feature/dhcp/         @alokmtri-g
 /feature/ethernet/     @ram-mac
+/feature/gribi/mpls_in_udp/       @openconfig/featureprofiles-owner-gribi-mpls-in-udp
 /feature/gribi/        @openconfig/featureprofiles-owner-gribi
 /feature/interface/    @openconfig/featureprofiles-owner-interface
 /feature/isis/         @openconfig/featureprofiles-owner-isis
 /feature/lldp/         @openconfig/featureprofiles-owner-lldp
 /feature/mpls/         @openconfig/featureprofiles-owner-mpls
 /feature/mtu/          @openconfig/featureprofiles-owner-mtu
 /feature/networkinstance/    @openconfig/featureprofiles-owner-networkinstance
-/feature/platform/           @openconfig/featureprofiles-owner-platform
 /feature/platform/transceiver  @openconfig/featureprofiles-owner-platform-transceiver
-/feature/qos                 @openconfig/featureprofiles-owner-qos
+/feature/platform/           @openconfig/featureprofiles-owner-platform
+/feature/qos/                @openconfig/featureprofiles-owner-qos
 /feature/routing_policy/     @swetha-haridasula
 /feature/sampling/           @masood-shah
 /feature/security            @openconfig/featureprofiles-owner-security
+/feature/gnsi/		     @openconfig/featureprofiles-owner-security
 /feature/staticroute/        @openconfig/featureprofiles-owner-staticroute
 /feature/stp/                @alokmtri-g
-/feature/system              @openconfig/featureprofiles-owner-system
+/feature/system/             @openconfig/featureprofiles-owner-system
 /feature/vrrp                @amrindrr
 
 # Common OTG utilities 

.github/workflows/go.yml

@@ -15,24 +15,28 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: 1.23.x
+        go-version-file: 'go.mod'
     - name: Cache
       uses: actions/cache@v4
       with:
         path: |
           ~/go/pkg/mod
           ~/.cache/go-build
         key: ${{ github.job }}-${{ runner.os }}-go-build-${{ hashFiles('**/go.sum') }}
+    # Dependency for Go module github.com/google/gopacket
+    - name: Install libpcap-dev
+      run: sudo apt-get -y install libpcap-dev
     - name: Build
       run: go build -v ./...
+
   test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.23.x
+          go-version-file: 'go.mod'
       - name: Cache
         uses: actions/cache@v4
         with:
@@ -45,17 +49,20 @@ jobs:
         run: sudo apt-get -y install libpcap-dev
       - run: go test -v -coverprofile=profile.cov $(go list ./... | grep -v /.*test.*)
       - name: Send coverage
+        continue-on-error: true
         uses: shogo82148/actions-goveralls@7b1bd2871942af030d707d6574e5f684f9891fb2
         with:
           path-to-profile: profile.cov
+
   static_analysis:
     name: Static Analysis
     runs-on: ubuntu-latest
     steps:
-    - name: Install go
+    - uses: actions/checkout@v4
+    - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: '1.23'
+        go-version-file: 'go.mod'
     # Go & staticcheck build cache require a lot of disk space.  Reclaim extra
     # space for the container by removing unnecessary tooling.
     - name: Free additional disk space
@@ -65,8 +72,6 @@ jobs:
         sudo rm -rf /opt/hostedtoolcache/CodeQL
         sudo mv "${HOME}/.cache" /mnt/cache
         ln -s /mnt/cache "${HOME}/.cache"
-    - name: Checkout code
-      uses: actions/checkout@v4
     - name: Cache
       uses: actions/cache@v4
       with:
@@ -78,6 +83,12 @@ jobs:
     # Dependency for Go module github.com/google/gopacket
     - name: Install libpcap-dev
       run: sudo apt-get -y install libpcap-dev
+
+    # === THIS IS THE ONLY CHANGE ===
+    - name: Clean Go build cache before analysis
+      run: go clean -cache
+    # ===============================
+
     - name: Go vet
       run: GOGC=30 go vet ./...
     - name: Gofmt

.github/workflows/protobufs.yml

@@ -43,42 +43,3 @@ jobs:
         for i in `find . -name \*.textproto`; do
           textproto-validator -I ./protobuf-import $i
         done
-
-  validate_oc_paths:
-    name: Validate OpenConfig Paths
-    runs-on: ubuntu-latest
-    steps:
-    - name: Install go
-      uses: actions/setup-go@v5
-      with:
-        go-version: '1.23'
-    - name: Checkout code
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Cache
-      uses: actions/cache@v4
-      with:
-        path: |
-          ~/go/pkg/mod
-          ~/.cache/go-build
-        key: ${{ github.job }}-${{ runner.os }}-go-build-${{ hashFiles('**/go.sum') }}
-    - name: Fetch OpenConfig Models
-      run: make openconfig_public
-    - name: Validate Paths
-      run: |
-        # https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
-        if [ ! -z "${GITHUB_BASE_REF}" ]; then
-          readonly HEAD=${{ github.event.pull_request.head.sha }}
-          readonly BASE="$(git merge-base origin/main "${HEAD}")"
-          if ! git diff --diff-filter=D --name-only "${BASE}" | grep -E 'feature.textproto$'; then
-            # If it is a pull request AND if no feature.textproto files were
-            # deleted, then we can skip checking all but the added/modified
-            # feature.textproto files.
-            export FEATURE_FILES=changed-feature-textprotos.githubactions.txt
-            # grep: don't error out on no match.
-            git diff --diff-filter=d --name-only "${BASE}" | { grep -E 'feature.textproto$' || true; } > "${FEATURE_FILES}"
-          fi
-        fi
-        make validate_paths
-

.github/workflows/readme_canonicaloc.yml

@@ -0,0 +1,91 @@
+name: README Canonical OC
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  schedule:
+  - cron: "49 0 * * *"
+
+jobs:
+  integration-test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744
+      with:
+        fetch-depth: 0
+    - name: Set up Go
+      uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe
+      with:
+        go-version-file: 'go.mod'
+        cache: false
+
+    - name: Validate Canonical OC Validation Script
+      run: |
+        cd tools/validate_readme_canonicalocspec
+        ./validate_readme_canonicalocspec_test.sh
+
+    - name: Validate Template README
+      run: |
+        go install ./tools/validate_readme_canonicalocspec
+        validate_readme_canonicalocspec --alsologtostderr doc/test-requirements-template.md
+
+    - name: Validate Test READMEs
+      run: |
+        go install ./tools/validate_readme_canonicalocspec
+
+        # TODO: Just use this one line after all READMEs have converted to the new format.
+        # validate_readme_canonicalocspec --alsologtostderr "${exemption_flags[@]}"
+
+        function validate() {
+          local exemption_flags=()
+          while IFS= read -r path; do
+            exemption_flags+="--non-test-readme $path "
+          done < ./tools/non_test_readmes.txt
+          validate_readme_canonicalocspec --feature-dir "$1" --alsologtostderr ${exemption_flags}
+        }
+
+        ##### BEGIN: Validate Changed Test READMEs # TODO: Remove this section after all are converted.
+
+        # Adapted from rebase_check.yml
+        # Notes:
+        #   * Do not use ${GITHUB_REF}, github.sha, or HEAD because they are
+        #     the merged commit of the pull request and main.  There are no
+        #     outdated files in the merged commit.
+        #   * refs/pull/${pr_number}/head is not available, so use
+        #     github.event.pull_request.head.sha which is the "head sha" of
+        #     the event that triggered the pull request.
+        #   * Do not use github.event.pull_request.base.sha because it is
+        #     the base when the pull request was created, not after a rebase.
+        #     Ask git merge-base to tell us a suitable base.
+        readonly HEAD="${{ github.event.pull_request.head.sha }}"
+        if [ ! -z "${HEAD}" ]; then
+          readonly BASE="$(git merge-base origin/main "${HEAD}")"
+
+          affected_readmes=()
+          for path in $(git diff --name-only --diff-filter=ACMRT "${BASE}" "${HEAD}" | grep -E '^\W*feature' | sort -u); do
+            if [[ "$path" == *README.md ]]; then
+              affected_readmes+=("$path")
+            fi
+          done
+
+          echo "########## READMEs in changed directories to be validated (including ones to be exempted):"
+          printf '%s\n' "${affected_readmes[@]}"
+
+          echo "########## Validating READMEs in changed directories:"
+          exemption_flags=()
+          while IFS= read -r path; do
+            exemption_flags+="--non-test-readme $path "
+          done < ./tools/non_test_readmes.txt
+          for f in "${affected_readmes[@]}"; do
+            validate_readme_canonicalocspec --alsologtostderr ${exemption_flags} "${f}"
+          done
+        fi
+
+        ##### END: Validate Changed Test READMEs #####
+
+        # TODO: Validate READMEs that have been converted to the new format.
+        # echo "########## Validating already-converted READMEs:"
+
+

.github/workflows/readme_oc_path_and_rpc.yml

@@ -35,17 +35,15 @@ jobs:
       run: |
         go install ./tools/validate_readme_spec
 
-        exemption_flags=(
-          --non-test-readme feature/security/gnsi/certz/test_data/README.md
-          --non-test-readme feature/p4rt/README.md
-          --non-test-readme feature/security/gnsi/acctz/README.md
-        )
-
         # TODO: Just use this one line after all READMEs have converted to the new format.
         # validate_readme_spec --alsologtostderr "${exemption_flags[@]}"
 
         function validate() {
-          validate_readme_spec --feature-dir "$1" --alsologtostderr "${exemption_flags[@]}"
+          local exemption_flags=()
+          while IFS= read -r path; do
+            exemption_flags+="--non-test-readme $path "
+          done < ./tools/non_test_readmes.txt
+          validate_readme_spec --feature-dir "$1" --alsologtostderr ${exemption_flags}
         }
 
         ##### BEGIN: Validate Changed Test READMEs # TODO: Remove this section after all are converted.
@@ -76,15 +74,19 @@ jobs:
           printf '%s\n' "${affected_readmes[@]}"
 
           echo "########## Validating READMEs in changed directories:"
+          exemption_flags=()
+          while IFS= read -r path; do
+            exemption_flags+="--non-test-readme $path "
+          done < ./tools/non_test_readmes.txt
           for f in "${affected_readmes[@]}"; do
-            validate_readme_spec --alsologtostderr "${exemption_flags[@]}" "${f}"
+            validate_readme_spec --alsologtostderr ${exemption_flags} "${f}"
           done
         fi
 
         ##### END: Validate Changed Test READMEs #####
 
         echo "########## Validating already-converted READMEs:"
-        validate feature/aft
+        validate feature/afts
         validate feature/bgp/policybase/otg_tests/import_export_multi_test
         validate feature/gnmi
         validate feature/gnoi
@@ -94,6 +96,7 @@ jobs:
         validate feature/security
         validate feature/staticroute
         validate feature/system/management
-        validate feature/system/gnmi/cliorigin/tests/mixed_oc_cli_origin_support_test
+        validate feature/gnmi/cliorigin/tests/mixed_oc_cli_origin_support_test
         validate feature/system/ntp/tests/system_ntp_test
         validate feature/qos/otg_tests/bursty_traffic_test
+

.github/workflows/required_approvals.yml

@@ -1,4 +1,3 @@
-# This workflow is to make sure we have 1 LGTM for business logic and 1 LGTM for code style
 name: PR Approval Workflow
 on:
   pull_request_target:
@@ -21,5 +20,5 @@ jobs:
         org_name: openconfig
         min_approvals: 1
         approval_mode: ALL
-        pr_number: ${{ github.event.number }}
+        pr_number: ${{ github.event.pull_request.number }}
         require_all_approvals_latest_commit: false

Makefile

@@ -39,10 +39,12 @@ protoimports:
 	find protobuf-import -type d -empty -delete
 	# Download the required dependencies
 	go mod download
-	# Get ondatra & kne modules we use and create required directory structure
+	# Get gnmi, ondatra & kne modules we use and create required directory structure
+	go list -f 'protobuf-import/{{ .Path }}' -m github.com/openconfig/gnmi | xargs -L1 dirname | sort | uniq | xargs mkdir -p
 	go list -f 'protobuf-import/{{ .Path }}' -m github.com/openconfig/ondatra | xargs -L1 dirname | sort | uniq | xargs mkdir -p
 	go list -f 'protobuf-import/{{ .Path }}' -m github.com/openconfig/kne | xargs -L1 dirname | sort | uniq | xargs mkdir -p
 	# Create symlinks
+	go list -f '{{ .Dir }} protobuf-import/{{ .Path }}' -m github.com/openconfig/gnmi | xargs -L1 -- ln -s
 	go list -f '{{ .Dir }} protobuf-import/{{ .Path }}' -m github.com/openconfig/ondatra | xargs -L1 -- ln -s
 	go list -f '{{ .Dir }} protobuf-import/{{ .Path }}' -m github.com/openconfig/kne | xargs -L1 -- ln -s
 	ln -s $(ROOT_DIR) protobuf-import/github.com/openconfig/featureprofiles
@@ -85,3 +87,4 @@ topologies/proto/binding/binding.pb.go: topologies/proto/binding.proto protoimpo
 clean:
 	rm -f $(GO_PROTOS)
 	rm -rf protobuf-import openconfig_public
+

doc/canonical_oc_generation_example/main.go

@@ -0,0 +1,71 @@
+// Package main provides an example program that outputs specific JSON for an OpenConfig schema.
+// It demonstrates how to use the ygot library to build and marshal OpenConfig data structures.
+// The program requires the YANG for a particular field to be defined.
+package main
+
+import (
+	"fmt"
+
+	"github.com/golang/glog"
+	"github.com/openconfig/ondatra/gnmi/oc"
+	"github.com/openconfig/ygot/ygot"
+)
+
+// This is an example program that outputs specific JSON for an OpenConfig
+// schema. It requires the YANG for a particular field to be defined such
+// that it can be used.
+//
+// You can find documentation of the schema on openconfig.net.
+// Particularly:
+//
+//   - https://openconfig.net/projects/models/paths/ - searchable list of paths.
+//   - https://openconfig.net/projects/models/schemadocs/ - documentation for each path.
+//
+// Expected output for the program run:
+//
+//	{
+//	  "interfaces": {
+//	    "interface": [
+//	      {
+//	        "config": {
+//	          "description": "a description",
+//	          "mtu": 1500,
+//	          "name": "eth0",
+//	          "type": "ethernetCsmacd"
+//	        },
+//	        "hold-time": {
+//	          "config": {
+//	            "up": 42
+//	          }
+//	        },
+//	        "name": "eth0"
+//	      }
+//	    ]
+//	  },
+//	  "system": {
+//	    "config": {
+//	      "hostname": "a hostname"
+//	    }
+//	  }
+//	}
+func main() {
+	d := &oc.Root{}
+
+	d.GetOrCreateInterface("eth0").GetOrCreateHoldTime().Up = ygot.Uint32(42)
+	d.GetOrCreateInterface("eth0").Type = oc.IETFInterfaces_InterfaceType_ethernetCsmacd
+	d.GetOrCreateInterface("eth0").Description = ygot.String("a description")
+	d.GetOrCreateInterface("eth0").Mtu = ygot.Uint16(1500)
+
+	d.GetOrCreateSystem().Hostname = ygot.String("a hostname")
+
+	fmt.Printf("%v\n", renderJSON(d))
+}
+
+func renderJSON(s ygot.GoStruct) string {
+	bs, err := ygot.Marshal7951(s, ygot.JSONIndent("  "), &ygot.RFC7951JSONConfig{PreferShadowPath: true})
+	if err != nil {
+		glog.Exitf("cannot marshal JSON, %v", err)
+		return ""
+	}
+	return string(bs)
+}