Support development of new checks

ukf · Dec 3, 2024 · 8618f1d · 8618f1d
1 parent 613e90a
commit 8618f1d
Show file tree

Hide file tree

Showing 5 changed files with 91 additions and 51 deletions.
diff --git a/validators/Dockerfile.next b/validators/Dockerfile.next
@@ -9,3 +9,4 @@ ADD overlays/all            BOOT-INF/
 ADD overlays/ukf-meta-prod  BOOT-INF/
 ADD overlays/010-common     BOOT-INF/
 ADD overlays/next           BOOT-INF/
+ADD overlays/development    BOOT-INF/
diff --git a/validators/Dockerfile.prod b/validators/Dockerfile.prod
@@ -9,3 +9,4 @@ ADD overlays/all            BOOT-INF/
 ADD overlays/ukf-meta-prod  BOOT-INF/
 ADD overlays/010-common     BOOT-INF/
 ADD overlays/prod           BOOT-INF/
+ADD overlays/development    BOOT-INF/
diff --git a/validators/overlays/all/classes/default-validator-stages.xml b/validators/overlays/all/classes/default-validator-stages.xml
@@ -7,56 +7,65 @@
     http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
     http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">
 
-    <!-- The list of tests (stages) used by the default validator following the eduGAIN profile -->
-    <util:list id="default_validator_stages">
-        <ref bean="checkSchemas"/>
-        <ref bean="check_validUntil"/>
-        <ref bean="check_adfs"/>
-        <ref bean="check_algsupport"/>
-        <ref bean="check_bindings"/>
-        <ref bean="check_cr"/>
-        <ref bean="check_entityid_prefix"/>
-        <ref bean="check_hoksso"/>
-        <ref bean="check_idpdisc"/>
-        <ref bean="check_idp_tls"/>
-        <ref bean="check_incmd"/>
-        <ref bean="check_init"/>
-        <ref bean="check_mdattr"/>
-        <ref bean="check_mdiop"/>
-        <ref bean="check_mdrpi"/>
-        <ref bean="check_mdui"/>
-        <ref bean="check_misc"/>
-        <ref bean="check_rands"/>
-        <ref bean="check_reqattr"/>
-        <ref bean="check_saml1"/>
-        <ref bean="check_saml2"/>
-        <ref bean="check_saml2_lang"/>
-        <ref bean="check_saml2int"/>
-        <ref bean="check_saml2meta"/>
-        <ref bean="check_saml2meta_urlattrs"/>
-        <ref bean="check_saml2meta_urls"/>
-        <ref bean="check_saml_strings"/>
-        <ref bean="check_shib_noregscope"/>
-        <ref bean="check_shibboleth"/>
-        <ref bean="check_sirtfi"/>
-        <ref bean="check_sp_tls"/>
-        <ref bean="check_uk_algorithms"/>
-        <ref bean="check_uk_trust"/>
-        <ref bean="check_namespaces"/>
-        <ref bean="check_standard_certificates"/>
-        <ref bean="check_edugain_scopes"/>
-        <ref bean="check_hasreginfo"/>
-        <!-- <ref bean="check_ukf_compromised"/> compromised-keys.txt is in ukf-data which would couple the two projects -->
-        <ref bean="check_aggregate"/>
-        <ref bean="check_filtered"/>
-        <ref bean="check_coco_v2_support"/>
-        <ref bean="check_sirtfi2"/>
+    <!--
+        default_validator_stages
 
-        <!-- UKFed specific stages -->
-        <ref bean="check_ukfedlabel"/>
-        <ref bean="check_uk_mdrps"/>
-        <ref bean="check_uk_rands"/>
-        <ref bean="check_uk_mdattr"/>
-    </util:list>
+        This composite stage runs the checks used by the default validator.
+        This largely follows the eduGAIN profile.
+    -->
+    <bean id="default_validator_stages" parent="mda.CompositeStage">
+        <property name="stages">
+            <util:list>
+                <ref bean="checkSchemas"/>
+                <ref bean="check_validUntil"/>
+                <ref bean="check_adfs"/>
+                <ref bean="check_algsupport"/>
+                <ref bean="check_bindings"/>
+                <ref bean="check_cr"/>
+                <ref bean="check_entityid_prefix"/>
+                <ref bean="check_hoksso"/>
+                <ref bean="check_idpdisc"/>
+                <ref bean="check_idp_tls"/>
+                <ref bean="check_incmd"/>
+                <ref bean="check_init"/>
+                <ref bean="check_mdattr"/>
+                <ref bean="check_mdiop"/>
+                <ref bean="check_mdrpi"/>
+                <ref bean="check_mdui"/>
+                <ref bean="check_misc"/>
+                <ref bean="check_rands"/>
+                <ref bean="check_reqattr"/>
+                <ref bean="check_saml1"/>
+                <ref bean="check_saml2"/>
+                <ref bean="check_saml2_lang"/>
+                <ref bean="check_saml2int"/>
+                <ref bean="check_saml2meta"/>
+                <ref bean="check_saml2meta_urlattrs"/>
+                <ref bean="check_saml2meta_urls"/>
+                <ref bean="check_saml_strings"/>
+                <ref bean="check_shib_noregscope"/>
+                <ref bean="check_shibboleth"/>
+                <ref bean="check_sirtfi"/>
+                <ref bean="check_sp_tls"/>
+                <ref bean="check_uk_algorithms"/>
+                <ref bean="check_uk_trust"/>
+                <ref bean="check_namespaces"/>
+                <ref bean="check_standard_certificates"/>
+                <ref bean="check_edugain_scopes"/>
+                <ref bean="check_hasreginfo"/>
+                <!-- <ref bean="check_ukf_compromised"/> compromised-keys.txt is in ukf-data which would couple the two projects -->
+                <ref bean="check_aggregate"/>
+                <ref bean="check_filtered"/>
+                <ref bean="check_coco_v2_support"/>
+                <ref bean="check_sirtfi2"/>
+
+                <!-- UKFed specific stages -->
+                <ref bean="check_ukfedlabel"/>
+                <ref bean="check_uk_mdrps"/>
+                <ref bean="check_uk_rands"/>
+                <ref bean="check_uk_mdattr"/>
+            </util:list>
+        </property>
+    </bean>
 
 </beans>
diff --git a/validators/overlays/all/classes/default-validator.xml b/validators/overlays/all/classes/default-validator.xml
@@ -37,7 +37,12 @@
         *********************************
     -->
     <bean id="pipeline" parent="mda.SimplePipeline">
-        <property name="stages" ref="default_validator_stages"/>
+        <property name="stages">
+            <util:list>
+                <ref bean="default_validator_stages"/>
+                <ref bean="development_stages"/>
+            </util:list>
+        </property>
     </bean>
 
     <!--
@@ -49,5 +54,6 @@
     -->
     <import resource="default-validator-stages.xml"/>
     <import resource="default-validator-beans-overrides.xml"/>
+    <import resource="development-stages.xml"/>
 
 </beans>
diff --git a/validators/overlays/development/classes/development-stages.xml b/validators/overlays/development/classes/development-stages.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+    default-lazy-init="true"
+    xmlns:util="http://www.springframework.org/schema/util"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="
+    http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+    http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">
+
+    <!--
+        development_stages
+
+        This composite stage runs any checks under development.
+    -->
+    <bean id="development_stages" parent="mda.CompositeStage">
+        <property name="stages">
+            <util:list>
+                <!-- Under-development checks go here. -->
+            </util:list>
+        </property>
+    </bean>
+
+</beans>