Reduce string fields by introducing better typing (#3617)

* Reduce string fields by introducing better typing Signed-off-by: 1000TurquoisePogs <[email protected]> * Add new reusable types Signed-off-by: 1000TurquoisePogs <[email protected]> --------- Signed-off-by: 1000TurquoisePogs <[email protected]> Signed-off-by: Mark Ackert <[email protected]> Co-authored-by: Mark Ackert <[email protected]>
zowe · Nov 28, 2023 · 1190cbb · 1190cbb
1 parent 6cfe733
commit 1190cbb
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 21 deletions.
diff --git a/schemas/server-common.json b/schemas/server-common.json
@@ -46,6 +46,27 @@
       "minLength": 1,
       "maxLength": 8
     },
+    "userAnyCase": {
+      "$anchor": "zoweUserAnyCase",
+      "type": "string",
+      "pattern": "^([A-Za-z0-9$#@]){1,8}$",
+      "minLength": 1,
+      "maxLength": 8
+    },
+    "groupNameAnyCase": {
+      "$anchor": "zoweGroupNameAnyCase",
+      "type": "string",
+      "pattern": "[A-Z#$@][A-Z0-9Z#@]{0,7}",
+      "minLength": 1,
+      "maxLength": 8
+    },
+    "groupNameUppercase": {
+      "$anchor": "zoweGroup",
+      "type": "string",
+      "pattern": "[A-Za-z#$@][A-Za-z0-9Z#@]{0,7}",
+      "minLength": 1,
+      "maxLength": 8
+    },
     "token": {
       "$anchor": "zoweToken",
       "type": "string",

diff --git a/schemas/zowe-yaml-schema.json b/schemas/zowe-yaml-schema.json
@@ -21,15 +21,15 @@
               "description": "MVS data set related configurations",
               "properties": {
                 "prefix": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "Where Zowe MVS data sets will be installed"
                 },
                 "proclib": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "PROCLIB where Zowe STCs will be copied over"
                 },
                 "parmlib": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "Zowe PARMLIB"
                 },
                 "parmlibMembers": {
@@ -44,21 +44,21 @@
                   }
                 },
                 "jcllib": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "JCL library where Zowe will store temporary JCLs during initialization"
                 },
                 "loadlib": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "States the dataset where Zowe executable utilities are located",
                   "default": "<hlq>.SZWELOAD"
                 },
                 "authLoadlib": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "The dataset that contains any Zowe core code that needs to run APF-authorized, such as ZIS",
                   "default": "<hlq>.SZWEAUTH"
                 },
                 "authPluginLib": {
-                  "type": "string",
+                  "$ref": "/schemas/v2/server-common#zoweDataset",
                   "description": "APF authorized LOADLIB for Zowe ZIS Plugins"
                 }
               }
@@ -103,17 +103,17 @@
                   "description": "security group name",
                   "properties": {
                     "admin": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweGroupNameAnyCase",
                       "description": "Zowe admin user group",
                       "default": "ZWEADMIN"
                     },
                     "stc": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweGroupNameAnyCase",
                       "description": "Zowe STC group",
                       "default": "ZWEADMIN"
                     },
                     "sysProg": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweGroupNameAnyCase",
                       "description": "Zowe SysProg group",
                       "default": "ZWEADMIN"
                     }
@@ -125,12 +125,12 @@
                   "description": "security user name",
                   "properties": {
                     "zowe": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweUserAnyCase",
                       "description": "Zowe runtime user name of main service",
                       "default": "ZWESVUSR"
                     },
                     "zis": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweUserAnyCase",
                       "description": "Zowe runtime user name of ZIS",
                       "default": "ZWESIUSR"
                     }
@@ -142,17 +142,17 @@
                   "description": "STC names",
                   "properties": {
                     "zowe": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweJobname",
                       "description": "STC name of main service",
                       "default": "ZWESLSTC"
                     },
                     "zis": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweJobname",
                       "description": "STC name of ZIS",
                       "default": "ZWESISTC"
                     },
                     "aux": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweJobname",
                       "description": "STC name of Auxiliary Service",
                       "default": "ZWESASTC"
                     }
@@ -244,7 +244,7 @@
                   "description": "Configure this section if you are using z/OS keyring",
                   "properties": {
                     "owner": {
-                      "type": "string",
+                      "$ref": "/schemas/v2/server-common#zoweUserAnyCase",
                       "description": "keyring owner. If this is empty, Zowe will use the user ID defined as zowe.setup.security.users.zowe."
                     },
                     "name": {
@@ -282,7 +282,7 @@
                       "description": "Configure this section if you want to import existing certificate stored in data set to Zowe.",
                       "properties": {
                         "dsName": {
-                          "type": "string",
+                          "$ref": "/schemas/v2/server-common#zoweDataset",
                           "description": "Name of the data set holds the certificate issued by other CA. This data set should be in PKCS12 format and contain private key."
                         },
                         "password": {
@@ -301,7 +301,7 @@
                           "description": "z/OSMF certificate authority alias"
                         },
                         "user": {
-                          "type": "string",
+                          "$ref": "/schemas/v2/server-common#zoweUserAnyCase",
                           "description": "z/OSMF user. Zowe initialization utility can detect alias of z/OSMF CA for RACF security system. The automated detection requires this z/OSMF user as input."
                         }
                       }
@@ -339,7 +339,8 @@
                     },
                     "country": {
                       "type": "string",
-                      "description": "2 letters country code of certificate generated by Zowe."
+                      "description": "2 letters country code of certificate generated by Zowe.",
+                      "pattern": "[A-Z][A-Z]"
                     }
                   }
                 },
@@ -377,7 +378,8 @@
                 },
                 "volume": {
                   "type": "string",
-                  "description": "Volume name if you are using VSAM in NONRLS mode"
+                  "description": "Volume name if you are using VSAM in NONRLS mode",
+                  "maxLength": 6
                 },
                 "storageClass": {
                   "type": "string",
@@ -409,7 +411,7 @@
           "description": "Customize your Zowe z/OS JES job.",
           "properties": {
             "name": {
-              "type": "string",
+              "$ref": "/schemas/v2/server-common#zoweJobname",
               "description": "Job name of Zowe primary ZWESLSTC started task."
             },
             "prefix": {