Merge pull request #272 from zowe/v3-staging

Make Server Install wizard download with Zowe V3 and V2

Author: DivergentEuropeans

.github/pull_request_template.md

@@ -19,7 +19,7 @@ Please delete options that are not relevant.
 ## PR Checklist
 Please delete options that are not relevant.
 - [ ] If the changes in this PR are meant for the next release / mainline, this PR targets a "staging" branch.
-- [ ] My code follows the style guidelines of this project (see: [Contributing guideline](https://github.com/zowe/zen/blob/v2.x/staging/CONTRIBUTING.md))
+- [ ] My code follows the style guidelines of this project (see: [Contributing guideline](https://github.com/zowe/zen/blob/v3.x/staging/CONTRIBUTING.md))
 - [ ] I have commented my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
 - [ ] New and existing unit tests pass locally with my changes

.github/workflows/build_test.yml

@@ -2,8 +2,7 @@ name: Build zen
 on:
   push:
     branches:
-      - v2.x/main
-      - v2.x/staging
+      - v3.x/staging
 
   pull_request:
     types: [opened, reopened, synchronize]

.github/workflows/test-linter.yml

@@ -3,7 +3,7 @@ name: Lint TypeScript
 on:
   push:
     branches:
-      - v2.x/staging
+      - v3.x/staging
   pull_request:
     types: [opened, reopened, synchronize]
 

playwright_test/README.MD

@@ -41,13 +41,13 @@ Example command:
   JOB_PREFIX=ZWE \
   JAVA_HOME=/path/to/java \
   NODE_HOME=/path/to/node \
-  DATASET_PREFIX=IBMUSER.ZWEV2 \
+  DATASET_PREFIX=IBMUSER.ZWEV3 \
   PROC_LIB=USER.PROCLIB \
-  PARM_LIB=IBMUSER.ZWEV2.CUST.PARMLIB \
-  JCL_LIB=IBMUSER.ZWEV2.CUST.PARMLIB \
-  LOAD_LIB=IBMUSER.ZWEV2.SZWELOAD \
-  AUTH_LOAD_LIB=IBMUSER.ZWEV2.SZWEAUTH \
-  AUTH_PLUGIN_LIB=IBMUSER.ZWEV2.CUST.ZWESAPL \
+  PARM_LIB=IBMUSER.ZWEV3.CUST.PARMLIB \
+  JCL_LIB=IBMUSER.ZWEV3.CUST.PARMLIB \
+  LOAD_LIB=IBMUSER.ZWEV3.SZWELOAD \
+  AUTH_LOAD_LIB=IBMUSER.ZWEV3.SZWEAUTH \
+  AUTH_PLUGIN_LIB=IBMUSER.ZWEV3.CUST.ZWESAPL \
   SECURITY_ADMIN=ZWEADMIN \
   SECURITY_SYSPROG=ZWEADMIN \
   SECURITY_STC=ZWEADMIN \

src/actions/InstallationHandler.ts

@@ -20,6 +20,7 @@ import { ConfigurationStore } from '../storage/ConfigurationStore';
 import { InstallationArgs } from '../types/stateInterfaces';
 import { FALLBACK_SCHEMA, deepMerge } from '../renderer/components/common/Utils';
 import { updateSchemaReferences } from '../services/ResolveRef';
+import { PlanningActions } from './PlanningActions';
 
 class Installation {
 
@@ -219,8 +220,14 @@ class Installation {
       }
 
       let download, upload, unpax;
-      if(installationArgs.installationType === "download"){
-        console.log("downloading...", version);
+      if(installationArgs.installationType === "downloadV2" || installationArgs.installationType === "downloadV3"){
+        if (installationArgs.installationType === "downloadV2") {
+          await PlanningActions.getZoweFullVersion(2).then(async (res: IResponse) => { // Retrieve full Zowe version from user selection
+            version = res.details;
+          });
+          await PlanningActions.setZoweMajorVersion(2); // Update as Wizard's UI will begin relying on this
+        } // else: Zowe Version 3, which was set as default already
+        console.log("Starting " + installationArgs.installationType.toString() + "...", version);
         download = await this.downloadPax(version);
         ProgressStore.set('downloadUnpax.download', download.status);
       } else {
@@ -238,8 +245,8 @@ class Installation {
         //upload the PAX the user selected in the "Install Type" stage to the installation dir (from the planning stage)
         console.log('Uploading user selected pax from ', installationArgs.userUploadedPaxPath)
         upload = await new FileTransfer().upload(connectionArgs, installationArgs.userUploadedPaxPath, path.join(installationArgs.installationDir, "zowe.pax"), DataType.BINARY)
-      } else if (installationArgs.installationType === "download"){
-        console.log('Uploading pax downloaded from jfrog')
+      } else if (installationArgs.installationType === "downloadV2" || installationArgs.installationType === "downloadV3"){
+        console.log('Uploading pax downloaded from jfrog');
         upload = await this.uploadPax(connectionArgs, installationArgs.installationDir);
       }
       ProgressStore.set('downloadUnpax.upload', upload.status);

src/actions/PlanningActions.ts

@@ -17,6 +17,8 @@ import { ConfigurationStore } from "../storage/ConfigurationStore";
 import { parse } from 'yaml';
 import * as https from 'https';
 import { checkDirExists, makeDir } from '../services/ServiceUtils'
+import { DEF_ZOWE_MAJOR_VERS } from "../renderer/components/common/Utils";
+import { ProgressStore } from "../storage/ProgressStore";
 
 export class PlanningActions {
 
@@ -51,9 +53,10 @@ export class PlanningActions {
     }
   }
 
-  public static getExampleZowe(): Promise<IResponse> {
+  // majorVers optional or def to DEF_ZOWE_MAJOR_VERS
+  public static getExampleZowe(majorVersion?: number): Promise<IResponse> {
     return new Promise((resolve, reject) => {
-      https.get('https://raw.githubusercontent.com/zowe/zowe-install-packaging/v3.x/master/example-zowe.yaml', (res) => {
+      https.get(`https://raw.githubusercontent.com/zowe/zowe-install-packaging/v${majorVersion || DEF_ZOWE_MAJOR_VERS}.x/master/example-zowe.yaml`, (res) => {
         let data = '';
 
         res.on('data', (chunk) => {
@@ -75,9 +78,10 @@ export class PlanningActions {
     });
   }
 
-  public static getZoweSchema(): Promise<IResponse> {
+  // majorVers optional or def to DEF_ZOWE_MAJOR_VERS
+  public static getZoweSchema(majorVersion?: number): Promise<IResponse> {
     return new Promise((resolve, reject) => {
-      https.get('https://raw.githubusercontent.com/zowe/zowe-install-packaging/v3.x/master/schemas/zowe-yaml-schema.json', (res) => {
+      https.get(`https://raw.githubusercontent.com/zowe/zowe-install-packaging/v${majorVersion || DEF_ZOWE_MAJOR_VERS}.x/master/schemas/zowe-yaml-schema.json`, (res) => {
         let data = '';
 
         res.on('data', (chunk) => {
@@ -108,9 +112,10 @@ export class PlanningActions {
     }
   }
 
-  public static async getZoweVersion(): Promise<IResponse> {
+  // majorVers optional or def to DEF_ZOWE_MAJOR_VERS
+  public static async getZoweFullVersion(majorVersion?: number): Promise<IResponse> {
     return new Promise<IResponse>((resolve, reject) => {
-      https.get('https://raw.githubusercontent.com/zowe/zowe-install-packaging/v3.x/master/manifest.json.template', (res) => {
+      https.get(`https://raw.githubusercontent.com/zowe/zowe-install-packaging/v${majorVersion || DEF_ZOWE_MAJOR_VERS}.x/master/manifest.json.template`, (res) => {
         let data = '';
 
         res.on('data', (chunk) => {
@@ -132,6 +137,15 @@ export class PlanningActions {
     });
   }
 
+  public static setZoweMajorVersion = (majorVersion: number): void => {
+    ProgressStore.setZoweMajorVersion(majorVersion);
+  }
+  
+  public static getZoweMajorVersion = () : number => {
+    const version = ProgressStore.getZoweMajorVersion();
+    return version ? Number(version) : NaN;
+  }
+
   public static async setConfigByKeyAndValidate(key: string, value: string | Array<string>): Promise<IResponse> {
     const status = ConfigurationStore.setConfigByKeyAndValidate(key, value);
     return {status, details: ''};

src/main/index.ts

@@ -159,8 +159,18 @@ const createWindow = (): void => {
     return res;
   });
 
-  ipcMain.handle('get-zowe-version', async () => {
-    const res = await PlanningActions.getZoweVersion();
+  ipcMain.handle('get-zowe-full-version', async (event, value?: number) => {
+    const res = await PlanningActions.getZoweFullVersion(value);
+    return res;
+  });
+
+  ipcMain.handle('get-zowe-major-version', async () => {
+    const res = await PlanningActions.getZoweMajorVersion();
+    return res;
+  });
+
+  ipcMain.handle('set-zowe-major-version', async (event, value: number) => {
+    const res = await PlanningActions.setZoweMajorVersion(value);
     return res;
   });
 

src/renderer/components/common/Utils.tsx

@@ -18,6 +18,7 @@ export const TYPE_OUTPUT = "output";
 
 export const DEF_NO_OUTPUT = "No output to display."
 export const DEF_JOB_STATEMENT = `//ZWEJOB01 JOB IZUACCT,'SYSPROG',CLASS=A,\n//         MSGLEVEL=(1,1),MSGCLASS=A`;
+export const DEF_ZOWE_MAJOR_VERS = "3";
 
 export const CONNECTION_STAGE_LABEL = "Connection";
 export const PLANNING_STAGE_LABEL = "Planning";
@@ -57,9 +58,21 @@ export function isValidUSSPath(path: string): boolean {
   return validUSSRegex.test(path);
 }
 
+export function doesUSSPathContain(parentLocation: string, compareLocation: string): boolean {
+  if (!parentLocation || !compareLocation) return false;
+
+  // Remove trailing slashes
+  const normalParent = parentLocation.replace(/\/+$/, '');
+  const normalCompare = compareLocation.replace(/\/+$/, '');
+
+  // Ensure compareLocation is truly (not false positive) a subdirectory of parentLocation via "/"
+  return normalCompare.startsWith(`${normalParent}/`);
+};
+
+
 export const SERVER_COMMON = {
   "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "$id": "https://zowe.org/schemas/v2/server-common",
+  "$id": "https://zowe.org/schemas/v3/server-common",
   "title": "Common types",
   "description": "Configuration types that are common in Zowe and may be referenced by multiple components",
   "$defs": {
@@ -155,7 +168,7 @@ export const SERVER_COMMON = {
 
 export const BASE_SCHEMA = {
   "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "$id": "https://zowe.org/schemas/v2/server-base",
+  "$id": "https://zowe.org/schemas/v3/server-base",
   "title": "Zowe configuration file",
   "description": "Configuration file for Zowe (zowe.org) version 2.",
   "type": "object",
@@ -193,7 +206,7 @@ export const BASE_SCHEMA = {
                   "description": "Holds Zowe PARMLIB members for plugins",
                   "properties": {
                     "zis": {
-                      "$ref": "/schemas/v2/server-common#zoweDatasetMember",
+                      "$ref": "/schemas/v3/server-common#zoweDatasetMember",
                       "description": "PARMLIB member used by ZIS"
                     }
                   }
@@ -345,7 +358,7 @@ export const BASE_SCHEMA = {
                   "description": "PKCS#12 keystore settings",
                   "properties": {
                     "directory": {
-                      "$ref": "/schemas/v2/server-common#zowePath",
+                      "$ref": "/schemas/v3/server-common#zowePath",
                       "description": "Keystore directory"
                     },
                     "name": {
@@ -543,19 +556,19 @@ export const BASE_SCHEMA = {
           }
         },
         "runtimeDirectory": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Path to where you installed Zowe."
         },
         "logDirectory": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Path to where you want to store Zowe log files."
         },
         "workspaceDirectory": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Path to where you want to store Zowe workspace files. Zowe workspace are used by Zowe component runtime to store temporary files."
         },
         "extensionDirectory": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Path to where you want to store Zowe extensions. \"zwe components install\" will install new extensions into this directory."
         },
         "job": {
@@ -707,7 +720,7 @@ export const BASE_SCHEMA = {
       "type": "object",
       "properties": {
         "home": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Path to Java home directory."
         }
       }
@@ -716,7 +729,7 @@ export const BASE_SCHEMA = {
       "type": "object",
       "properties": {
         "home": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Path to node.js home directory."
         }
       }
@@ -817,7 +830,7 @@ export const BASE_SCHEMA = {
               "const": "PKCS12"
             },
             "file": {
-              "$ref": "/schemas/v2/server-common#zowePath",
+              "$ref": "/schemas/v3/server-common#zowePath",
               "description": "Path to your PKCS#12 keystore."
             },
             "password": {
@@ -842,7 +855,7 @@ export const BASE_SCHEMA = {
               "const": "PKCS12"
             },
             "file": {
-              "$ref": "/schemas/v2/server-common#zowePath",
+              "$ref": "/schemas/v3/server-common#zowePath",
               "description": "Path to your PKCS#12 keystore."
             },
             "password": {
@@ -858,24 +871,24 @@ export const BASE_SCHEMA = {
           "required": ["key", "certificate"],
           "properties": {
             "key": {
-              "$ref": "/schemas/v2/server-common#zowePath",
+              "$ref": "/schemas/v3/server-common#zowePath",
               "description": "Path to the certificate private key stored in PEM format."
             },
             "certificate": {
-              "$ref": "/schemas/v2/server-common#zowePath",
+              "$ref": "/schemas/v3/server-common#zowePath",
               "description": "Path to the certificate stored in PEM format."
             },
             "certificateAuthorities": {
               "description": "List of paths to the certificate authorities stored in PEM format.",
               "oneOf": [{
-                  "$ref": "/schemas/v2/server-common#zowePath",
+                  "$ref": "/schemas/v3/server-common#zowePath",
                   "description": "Paths to the certificate authorities stored in PEM format. You can separate multiple certificate authorities by comma."
                 },
                 {
                   "type": "array",
                   "description": "Path to the certificate authority stored in PEM format.",
                   "items": {
-                    "$ref": "/schemas/v2/server-common#zowePath"
+                    "$ref": "/schemas/v3/server-common#zowePath"
                   }
                 }
               ]
@@ -1085,7 +1098,7 @@ export const BASE_SCHEMA = {
               "type": "array",
               "description": "The IP addresses which all of the Zowe servers will be binding on and listening to. Some servers may only support listening on the first element.",
               "items": {
-                "$ref": "/schemas/v2/server-common#zoweIpv4"
+                "$ref": "/schemas/v3/server-common#zoweIpv4"
               }
             },
             "vipaIp": {
@@ -1121,7 +1134,7 @@ export const BASE_SCHEMA = {
           "description": "The location of the default registry for this handler. It could be a URL, path, dataset, whatever this handler supports"
         },
         "path": {
-          "$ref": "/schemas/v2/server-common#zowePath",
+          "$ref": "/schemas/v3/server-common#zowePath",
           "description": "Unix file path to the configmgr-compatible JS file which implements the handler API"
         }
       }
@@ -1133,7 +1146,7 @@ export const BASE_SCHEMA = {
 //this schema fixes ajv not resolving references properly
 export const FALLBACK_SCHEMA = {
   "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "$id": "https://zowe.org/schemas/v2/server-base",
+  "$id": "https://zowe.org/schemas/v3/server-base",
   "title": "Zowe configuration file",
   "description": "Configuration file for Zowe (zowe.org) version 2.",
   "type": "object",
@@ -2124,7 +2137,7 @@ export const FALLBACK_SCHEMA = {
 
 //these two consts allow the whole schema to be validated
 export const ajv2019 = new Ajv2019({schemas: [BASE_SCHEMA, SERVER_COMMON]}).addKeyword("$anchor")
-export const schemaValidate = ajv2019.getSchema("https://zowe.org/schemas/v2/server-base")
+export const schemaValidate = ajv2019.getSchema("https://zowe.org/schemas/v3/server-base")
 
 
 export const ajv = new Ajv2019().addKeyword("$anchor").addSchema(SERVER_COMMON);
@@ -2187,17 +2200,17 @@ export const FALLBACK_YAML = {
     "cookieIdentifier": "1", 
     "verifyCertificates": "STRICT", 
     "setup": {
-      "dataset": {
-        "authLoadlib": "IBMUSER.ZWEV2.SZWEAUTH", 
+      "dataset": { // TODO: Dynamically switch `ZWE` with ZWEV2/ZWEV3 and re-run fallback<-->Wizard yaml obj init code during Downloading & .pax upload step
+        "authLoadlib": "IBMUSER.ZWE.SZWEAUTH", 
         "proclib": "USER.PROCLIB", 
-        "authPluginLib": "IBMUSER.ZWEV2.CUST.ZWESAPL", 
-        "prefix": "IBMUSER.ZWEV2", 
-        "parmlib": "IBMUSER.ZWEV2.CUST.PARMLIB", 
-        "loadlib": "IBMUSER.ZWEV2.SZWELOAD", 
+        "authPluginLib": "IBMUSER.ZWE.CUST.ZWESAPL", 
+        "prefix": "IBMUSER.ZWE", 
+        "parmlib": "IBMUSER.ZWE.CUST.PARMLIB", 
+        "loadlib": "IBMUSER.ZWE.SZWELOAD", 
         "parmlibMembers": {
           "zis": "ZWESIP00"
         }, 
-        "jcllib": "IBMUSER.ZWEV2.CUST.JCLLIB"
+        "jcllib": "IBMUSER.ZWE.CUST.JCLLIB"
       }, 
       "certificate": {
         "type": "PKCS12",