From 0fa314f7751bbfc3b6b7cd5d34d8ce09a59d4d49 Mon Sep 17 00:00:00 2001
From: Darren Loher <dloher@google.com>
Date: Thu, 26 Oct 2023 14:18:13 -0700
Subject: [PATCH] add IC utilization readme (#2273)

* add IC utilization readme
---
 .../otg_tests/utilization/README.md           | 60 +++++++++++++++++++
 testregistry.textproto                        |  6 ++
 2 files changed, 66 insertions(+)
 create mode 100644 feature/platform/integrated_circuit/otg_tests/utilization/README.md

diff --git a/feature/platform/integrated_circuit/otg_tests/utilization/README.md b/feature/platform/integrated_circuit/otg_tests/utilization/README.md
new file mode 100644
index 00000000000..0590372951e
--- /dev/null
+++ b/feature/platform/integrated_circuit/otg_tests/utilization/README.md
@@ -0,0 +1,60 @@
+# IC-1: Integrated Circuit Utilization and Thresholds
+
+## Summary
+
+Test resource utilization and threshold for `INTEGRATED_CIRCUIT` (IC) components.
+
+## Procedure
+
+* IC-1.1
+  * Get IC component names
+  * Verify resource utilization and threshold leaves exist for component
+  type `INTEGRATED_CIRCUIT`
+* IC-1.2
+  * Configure `used-threshold-upper` at 10% for resource IC
+  * Configure `used-threshold-upper-clear` at 5% for resource IC
+  * Verify state for the above leaves equals the configured values
+* IC-1.4
+  * Configure ISIS and BGP on DUT and ATE
+  * subscribe using SAMPLE mode to  `used` leaf.
+  * Advertise 100 IPv4 and IPv6 routes (200 total) from ATE to DUT
+  * Verify `used` leaf increases in value
+* IC-1.5
+  * subscribe ON_CHANGE to `max-limit` from DUT
+  * subscribe ON_CHANGE to `used-threshold-upper-exceeded`
+  * Add more IPv4 and IPv6 routes than `max-limit` * `used-threshold-upper`
+  * Verify `used-threshold-upper-exceeded` upper is true
+* IC-1.6
+  * Reduce ATE route advertisement to 100 IPv4 and IPv6 routes (200 total)
+  * Verify `used-threshold-upper-exceeded` upper is true
+
+## Config Parameter Coverage
+
+/components/component/chassis/utilization/resources/resource/config/name
+/system/utilization/resources/resource/config/name/used-threshold-upper
+/system/utilization/resources/resource/config/name/used-threshold-upper-clear
+/system/utilization/resources/resource/
+
+## Telemetry Parameter Coverage
+
+/system/utilization/resources/resource/state/active-component-list
+/components/component/chassis/utilization/resources/resource/state/committed
+/components/component/chassis/utilization/resources/resource/state/free
+/components/component/chassis/utilization/resources/resource/state/high-watermark
+/components/component/chassis/utilization/resources/resource/state/last-high-watermark
+/components/component/chassis/utilization/resources/resource/state/max-limit
+/components/component/chassis/utilization/resources/resource/state/name
+/components/component/chassis/utilization/resources/resource/state/used
+/components/component/chassis/utilization/resources/resource/state/used-threshold-upper
+/components/component/chassis/utilization/resources/resource/state/used-threshold-upper-clear
+
+## Protocol/RPC Parameter Coverage
+
+None
+
+## Required DUT platform
+
+This test should run on both
+
+* MFF - A modular form factor device containing LINECARDs, FABRIC and redundant CONTROLLER_CARD components
+* FFF - fixed form factor
diff --git a/testregistry.textproto b/testregistry.textproto
index faef6432e40..1bec01cf454 100644
--- a/testregistry.textproto
+++ b/testregistry.textproto
@@ -133,6 +133,12 @@ test: {
   readme: "https://github.com/openconfig/featureprofiles/blob/d26ac7fac5406af29c9a582b8d8ee73d56953e3b/feature/experimental/system/health/tests/system_generic_health_check/README.md"
   exec: " "
 }
+test: {
+  id: "IC-1"
+  description: "Integrated Circuit Utilization and Thresholds"
+  readme: "https://github.com/openconfig/featureprofiles/blob/main/feature/platform/integrated_circuit/otg_tests/utilization/README.md"
+  exec: " "
+}
 test: {
   id: "DP-1.9"
   description: "WRR traffic test"