Added warning comment in validators about adjusting *-format.

perfsonar · Feb 7, 2024 · c181bbd · c181bbd
1 parent fa07286
commit c181bbd
Show file tree

Hide file tree

Showing 26 changed files with 147 additions and 54 deletions.
diff --git a/pscheduler-test-clock/clock/validate.py b/pscheduler-test-clock/clock/validate.py
@@ -2,6 +2,12 @@
 # Validator for "trace" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate, json_validate_from_standard_template
 
 MAX_SCHEMA = 2

diff --git a/pscheduler-test-dhcp/dhcp/validate.py b/pscheduler-test-dhcp/dhcp/validate.py
@@ -2,16 +2,11 @@
 # Validator for a pScheduler Test
 #
 
+# IMPORTANT:
 #
-# Development Order #3:
-#
-# This file determines the required and optional data types which are 
-# allowed to be in the test spec and result.  This is used
-# for validation of these structures.
-#
-# Several existing datatypes are available for use at:
-# pscheduler/python-pscheduler/pscheduler/pscheduler/jsonval.py
-# 
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate
 

diff --git a/pscheduler-test-disk-to-disk/disk-to-disk/validate.py b/pscheduler-test-disk-to-disk/disk-to-disk/validate.py
@@ -2,16 +2,11 @@
 # Validator for "disk-to-disk" Test
 #
 
+# IMPORTANT:
 #
-# Development Order #3:
-#
-# This file determines the required and optional data types which are 
-# allowed to be in the test spec and result. This is used
-# for validation of these structures.
-#
-# Several existing datatypes are available for use at:
-# pscheduler/python-pscheduler/pscheduler/pscheduler/jsonval.py
-# 
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate
 

diff --git a/pscheduler-test-dns/dns/validate.py b/pscheduler-test-dns/dns/validate.py
@@ -2,6 +2,12 @@
 # Validator for "dns" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-dot1x/dot1x/validate.py b/pscheduler-test-dot1x/dot1x/validate.py
@@ -2,13 +2,11 @@
 # Validator for a pScheduler test and its result.
 #
 
+# IMPORTANT:
 #
-# Development Order #3: Test specification and result validation
-#
-# The functions in this file determine whether or not specifications
-# and results for this test are valid.
-#
-
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate_from_standard_template
 

diff --git a/pscheduler-test-http/http/validate.py b/pscheduler-test-http/http/validate.py
@@ -2,6 +2,12 @@
 # Validator for "http" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 # TODO: _ for sensitive values
 
 from pscheduler import json_validate

diff --git a/pscheduler-test-idle/idle/validate.py b/pscheduler-test-idle/idle/validate.py
@@ -2,6 +2,12 @@
 # Validator for "idle" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 2

diff --git a/pscheduler-test-idlebgm/idlebgm/validate.py b/pscheduler-test-idlebgm/idlebgm/validate.py
@@ -2,6 +2,12 @@
 # Validator for "idlebg" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-idleex/idleex/validate.py b/pscheduler-test-idleex/idleex/validate.py
@@ -2,6 +2,12 @@
 # Validator for "idleex" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-latency/latency/validate.py b/pscheduler-test-latency/latency/validate.py
@@ -2,6 +2,12 @@
 # Validator for "latency" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 3

diff --git a/pscheduler-test-latencybg/latencybg/validate.py b/pscheduler-test-latencybg/latencybg/validate.py
@@ -2,6 +2,17 @@
 # Validator for "latency" Test
 #
 
+#
+# Development Order #3:
+#
+# This file determines the required and optional data types which are 
+# allowed to be in the test spec and result. This is used
+# for validation of these structures.
+#
+# Several existing datatypes are available for use at:
+# pscheduler/python-pscheduler/pscheduler/pscheduler/jsonval.py
+# 
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-mtu/mtu/validate.py b/pscheduler-test-mtu/mtu/validate.py
@@ -2,16 +2,11 @@
 # Validator for a pScheduler Test
 #
 
+# IMPORTANT:
 #
-# Development Order #3:
-#
-# This file determines the required and optional data types which are 
-# allowed to be in the test spec and result. This is used
-# for validation of these structures.
-#
-# Several existing datatypes are available for use at:
-# pscheduler/python-pscheduler/pscheduler/pscheduler/jsonval.py
-# 
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate
 

diff --git a/pscheduler-test-netreach/netreach/validate.py b/pscheduler-test-netreach/netreach/validate.py
@@ -2,6 +2,12 @@
 # Validator for "netreach" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 import ipaddress
 
 from pscheduler import json_validate

diff --git a/pscheduler-test-noop/noop/validate.py b/pscheduler-test-noop/noop/validate.py
@@ -2,6 +2,12 @@
 # Validator for "noop" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-openports/openports/validate.py b/pscheduler-test-openports/openports/validate.py
@@ -2,16 +2,11 @@
 # Validator for a pScheduler Test
 #
 
+# IMPORTANT:
 #
-# Development Order #3:
-#
-# This file determines the required and optional data types which are 
-# allowed to be in the test spec and result. This is used
-# for validation of these structures.
-#
-# Several existing datatypes are available for use at:
-# pscheduler/python-pscheduler/pscheduler/pscheduler/jsonval.py
-# 
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate
 

diff --git a/pscheduler-test-psresponse/psresponse/validate.py b/pscheduler-test-psresponse/psresponse/validate.py
@@ -2,6 +2,12 @@
 # Validator for "psresponse" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-rtt/rtt/validate.py b/pscheduler-test-rtt/rtt/validate.py
@@ -2,6 +2,12 @@
 # Validator for "rtt" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 4

diff --git a/pscheduler-test-s3throughput/s3throughput/validate.py b/pscheduler-test-s3throughput/s3throughput/validate.py
@@ -2,6 +2,12 @@
 # Validator for "s3throughput" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate_from_standard_template
 from pscheduler import json_standard_template_max_schema
 

diff --git a/pscheduler-test-simplestream/simplestream/validate.py b/pscheduler-test-simplestream/simplestream/validate.py
@@ -2,6 +2,12 @@
 # Validator for "simplestream" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 2

diff --git a/pscheduler-test-snmpget/snmpget/validate.py b/pscheduler-test-snmpget/snmpget/validate.py
@@ -2,6 +2,12 @@
 # Validator for "snmpget" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-snmpgetbgm/snmpgetbgm/validate.py b/pscheduler-test-snmpgetbgm/snmpgetbgm/validate.py
@@ -2,6 +2,12 @@
 # Validator for "snmpget" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 1

diff --git a/pscheduler-test-snmpset/snmpset/validate.py b/pscheduler-test-snmpset/snmpset/validate.py
@@ -2,6 +2,12 @@
 # Validator for "snmpset" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 # TODO: _ for sensitive values
 
 from pscheduler import json_validate

diff --git a/pscheduler-test-throughput/throughput/validate.py b/pscheduler-test-throughput/throughput/validate.py
@@ -2,6 +2,12 @@
 # Validator for "throughput" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 import json
 

diff --git a/pscheduler-test-trace/trace/validate.py b/pscheduler-test-trace/trace/validate.py
@@ -2,6 +2,12 @@
 # Validator for "trace" Test
 #
 
+# IMPORTANT:
+#
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
+
 from pscheduler import json_validate
 
 MAX_SCHEMA = 2

diff --git a/pscheduler-test-wifibssid/wifibssid/validate.py b/pscheduler-test-wifibssid/wifibssid/validate.py
@@ -2,13 +2,11 @@
 # Validator for a pScheduler test and its result.
 #
 
+# IMPORTANT:
 #
-# Development Order #3: Test specification and result validation
-#
-# The functions in this file determine whether or not specifications
-# and results for this test are valid.
-#
-
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate_from_standard_template
 

diff --git a/scripts/PDK/templates/test/__PLUGIN_NAME__/validate.py b/scripts/PDK/templates/test/__PLUGIN_NAME__/validate.py
@@ -2,13 +2,11 @@
 # Validator for a pScheduler test and its result.
 #
 
+# IMPORTANT:
 #
-# Development Order #3: Test specification and result validation
-#
-# The functions in this file determine whether or not specifications
-# and results for this test are valid.
-#
-
+# When making changes to the JSON schemas in this file, corresponding
+# changes MUST be made in 'spec-format' and 'result-format' to make
+# them capable of formatting the new specifications and results.
 
 from pscheduler import json_validate_from_standard_template