Merge Next into Master

.github/workflows/audit.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     branches:
       - master
+      - zowe-v1-lts
+      - next
   # schedule:
   #   - cron: '0 10 * * *'
 

.github/workflows/changelog.yml

@@ -4,6 +4,8 @@ on:
   pull_request:
     branches:
       - master
+      - zowe-v1-lts
+      - next
 
 jobs:
   changelog:

.github/workflows/codeql.yml

@@ -4,9 +4,13 @@ on:
   push:
     branches:
       - master
+      - zowe-v1-lts
+      - next
   pull_request:
     branches:
       - master
+      - zowe-v1-lts
+      - next
   # schedule:
   #   - cron: '0 10 * * *'
 

.github/workflows/linter.yml

@@ -5,6 +5,7 @@ on:
     branches-ignore:
       - 'master'
       - 'zowe-v1-lts'
+      - 'next'
   pull_request:
     branches:
       - "**"

.github/workflows/zowe-cli-plugin.yml

@@ -52,6 +52,11 @@ jobs:
       if: ${{ always() && steps.build.outcome == 'success' }}
       run: npm run test:unit >> unit-tests.txt
 
+    - name: Unlock Keyring
+      id: unlock-keyring
+      if: ${{ always() && steps.build.outcome == 'success' && matrix.os == 'ubuntu-latest' }}
+      uses: t1m0thyj/unlock-keyring@master
+
     - name: Integration Tests
       id: integration
       if: ${{ always() && steps.build.outcome == 'success' }}

.npmrc

@@ -1,2 +1,2 @@
 registry=https://registry.npmjs.org/
-@zowe:registry=https://zowe.jfrog.io/zowe/api/npm/npm-release/
+@zowe:registry=https://zowe.jfrog.io/zowe/api/npm/npm-release/

CHANGELOG.md

@@ -2,6 +2,47 @@
 
 All notable changes to the IBM® IMS™ Plug-in for Zowe CLI will be documented in this file.
 
+## Recent Changes
+
+- Major: Updated for V2 compatibility. See the prerelease items below for more details.
+
+## `3.0.0-next.202204142150`
+
+- LTS Breaking: Updated the resource to use `api` instead of `apis`. [#23](https://github.com/zowe/zowe-cli-ims-plugin/issues/23)
+
+## `3.0.0-next.202204141926`
+
+- BugFix: Remove APIML Conn Lookup until the IMS definition for APIML is known.
+
+## `3.0.0-next.202204132012`
+
+- BugFix: Add missing `reject-unauthorized` flag.
+
+## `3.0.0-next.202204081444`
+
+- BugFix: Removed deprecated profiles API calls
+- BugFix: Fixed prompting in daemon mode
+
+## `3.0.0-next.202202071747`
+
+- BugFix: Pruned dev dependencies from npm-shrinkwrap file.
+
+## `3.0.0-next.202201261957`
+
+- BugFix: Included an npm-shrinkwrap file to lock-down all transitive dependencies.
+
+## `3.0.0-next.202107021833`
+
+- Enhancement: Add apimlConnLookup properties to enable auto-config through APIML. A valid apiId must still be identified.
+
+## `3.0.0-next.202106071926`
+
+- **Breaking**: Removed the previously deprecated function ImsRestClient.performRest(). The function ImsRestClient.request() must now be used.
+
+## `3.0.0-next.202104261402`
+
+- Remove @zowe/cli peer dependency to better support NPM v7
+
 ## `2.0.4`
 
 - BugFix: Updated `moment` dependency.

Jenkinsfile

@@ -29,10 +29,9 @@ node('zowe-jenkins-agent') {
 
     // Protected branch property definitions
     pipeline.protectedBranches.addMap([
-        [name: "master", tag: "latest", aliasTags: ["zowe-v1-lts"], devDependencies: ["@zowe/imperative": "zowe-v1-lts"], level: SemverLevel.MINOR],
-        //[name: "master", tag: "latest", devDependencies: ["@zowe/imperative": "latest"]],
-        //[name: "zowe-v1-lts", tag: "zowe-v1-lts", devDependencies: ["@zowe/imperative": "zowe-v1-lts"], level: SemverLevel.MINOR]
-        [name: "lts-incremental", tag: "lts-incremental", devDependencies: ["@zowe/imperative" :"lts-incremental"], level: SemverLevel.PATCH]
+        [name: "master", tag: "latest", level: SemverLevel.MINOR, aliasTags: ["zowe-v2-lts", "next"], devDependencies: ["@zowe/cli": "zowe-v2-lts", "@zowe/cli-test-utils": "zowe-v2-lts", "@zowe/imperative": "zowe-v2-lts"]],
+        [name: "zowe-v1-lts", tag: "zowe-v1-lts", level: SemverLevel.PATCH, devDependencies: ["@zowe/imperative": "zowe-v1-lts"]]
+        //[name: "next", tag: "next", prerelease: "next", devDependencies: ["@zowe/cli": "next", "@zowe/cli-test-utils": "next", "@zowe/imperative": "next"]]
     ])
 
     // Git configuration information
@@ -96,7 +95,7 @@ node('zowe-jenkins-agent') {
             autoUpdateStability: false,
             coberturaReportFile: '__tests__/__results__/unit/coverage/cobertura-coverage.xml',
             classCoverageTargets: '85, 80, 75',
-            conditionalCoverageTargets: '70, 65, 60',
+            conditionalCoverageTargets: '70, 65, 50',
             failUnhealthy: false,
             failUnstable: false,
             lineCoverageTargets: '80, 70, 50',
@@ -115,7 +114,7 @@ node('zowe-jenkins-agent') {
         name: "Integration",
         operation: {
             def zoweVersion = sh(returnStdout: true, script: "echo \$(cat package.json | grep '@zowe/cli' | head -1 | awk -F: '{ print \$2 }' | sed 's/[\",]//g')").trim()
-            sh "npm i -g @zowe/cli@$zoweVersion --zowe:registry=${pipeline.registryConfig[0].url}"
+            sh "npm i -g \"@zowe/cli@$zoweVersion\" --zowe:registry=${pipeline.registryConfig[0].url}"
             sh "npm run test:integration"
         },
         testResults: [dir: "${INTEGRATION_TEST_ROOT}/jest-stare", files: "index.html", name: "${PRODUCT_NAME} - Integration Test Report"],

__tests__/__integration__/cli/imsprofile.integration.test.ts

@@ -9,18 +9,17 @@
 *                                                                                 *
 */
 
-import { TestEnvironment } from "../../__src__/environment/TestEnvironment";
-import { ITestEnvironment } from "../../__src__/environment/doc/response/ITestEnvironment";
-import { runCliScript } from "../../__src__/TestUtils";
+import { ITestEnvironment, TestEnvironment, isStderrEmptyForProfilesCommand, runCliScript } from "@zowe/cli-test-utils";
+import { ITestPropertiesSchema } from "../../__src__/doc/ITestPropertiesSchema";
 
-let testEnvironment: ITestEnvironment;
+let testEnvironment: ITestEnvironment<ITestPropertiesSchema>;
 describe("Creating an IMS profile", () => {
 
     beforeAll(async () => {
         testEnvironment = await TestEnvironment.setUp({
             installPlugin: true,
-            skipProperties: true,
-            testName: "ims_profile"
+            testName: "ims_profile",
+            skipProperties: true
         });
     });
 
@@ -30,7 +29,7 @@ describe("Creating an IMS profile", () => {
 
     it("should create an IMS profile successfully with fake connection details", () => {
         const output = runCliScript(__dirname + "/__scripts__/create_ims_profile.sh", testEnvironment);
-        expect(output.stderr.toString()).toEqual("");
+        expect(isStderrEmptyForProfilesCommand(output.stderr)).toBeTruthy();
         expect(output.status).toEqual(0);
         expect(output.stdout.toString()).toContain("success");
     });

__tests__/__integration__/cli/query/program/__snapshots__/cli.query.program.integration.test.ts.snap

@@ -28,7 +28,7 @@ exports[`ims query program should display the query program help 1`] = `
  OPTIONS
  -------
 
-   --attributes  | --att (array)
+   --attributes | --att (array)
 
       Specifies the application program output fields to return.
 
@@ -37,105 +37,112 @@ exports[`ims query program should display the query program help 1`] = `
       LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT,
       EXPORTNEEDED, DB, RTC, TRAN, WORK
 
-   --status  | --st (array)
+   --status | --st (array)
 
       Selects programs for display that possess at least one of the specified program
       statuses.
 
       Allowed values: DB-NOTAVL, IOPREV, LOCK, NOTINIT, STOSCHD, TRACE
 
-   --route  | --rt (array)
+   --route | --rt (array)
 
       Specifies the routes to return.
 
  IMS CONNECTION OPTIONS
  ----------------------
 
-   --host  | -H (string)
+   --host | -H (string)
 
       The IMS Operations API server host name.
 
-   --port  | -P (number)
+   --port | -P (number)
 
       The IMS Operations API server port.
 
-   --ims-connect-host  | --ich (string)
+   --ims-connect-host | --ich (string)
 
       The hostname of your instance of IMS Connect. This is typically the hostname of
       the mainframe LPAR where IMS Connect is running.
 
-   --ims-connect-port  | --icp (number)
+   --ims-connect-port | --icp (number)
 
       The port of your instance of IMS Connect. This port can be found in your IMS
       Connect configuration file on the mainframe.
 
-   --plex  | -x (string)
+   --plex | -x (string)
 
       The name of the IMS plex.
 
-   --user  | -u (string)
+   --user | -u (string)
 
       The web server user name where the IMS Operations API resides.
 
-   --password  | --pass (string)
+   --password | --pass (string)
 
       The web server user password where the IMS Operations API resides.
 
-   --base-path  | --bp (string)
+   --base-path | --bp (string)
 
       The base path for your API mediation layer instance. Specify this option to
       prepend the base path to all z/OSMF resources when making REST requests. Do not
       specify this option if you are not using an API mediation layer.
 
+   --protocol (string)
+
+      Specifies protocol (http or https).
+
+      Default value: https
+      Allowed values: http, https
+
+   --reject-unauthorized | --ru (boolean)
+
+      Reject self-signed certificates.
+
+      Default value: true
+
  PROFILE OPTIONS
  ---------------
 
-   --ims-profile  | --ims-p (string)
+   --ims-profile | --ims-p (string)
 
       The name of a (ims) profile to load for this command execution.
 
-   --base-profile  | --base-p (string)
+   --base-profile | --base-p (string)
 
       The name of a (base) profile to load for this command execution.
 
  BASE CONNECTION OPTIONS
  -----------------------
 
-   --reject-unauthorized  | --ru (boolean)
-
-      Reject self-signed certificates.
-
-      Default value: true
-
-   --token-type  | --tt (string)
+   --token-type | --tt (string)
 
       The type of token to get and use for the API. Omit this option to use the
       default token type, which is provided by 'zowe auth login'.
 
-   --token-value  | --tv (string)
+   --token-value | --tv (string)
 
       The value of the token to pass to the API.
 
-   --cert-file  (local file path)
+   --cert-file (local file path)
 
       The file path to a certificate file to use for authentication
 
-   --cert-key-file  (local file path)
+   --cert-key-file (local file path)
 
       The file path to a certificate key file to use for authentication
 
  RESPONSE FORMAT OPTIONS
  -----------------------
 
-   --response-format-filter  | --rff (array)
+   --response-format-filter | --rff (array)
 
       Filter (include) fields in the response. Accepts an array of field/property
       names to include in the output response. You can filter JSON objects properties
       OR table columns/fields. In addition, you can use this option in conjunction
       with '--response-format-type' to reduce the output of a command to a single
       field/property or a list of a single field/property.
 
-   --response-format-type  | --rft (string)
+   --response-format-type | --rft (string)
 
       The command response output format type. Must be one of the following:
 
@@ -155,27 +162,27 @@ exports[`ims query program should display the query program help 1`] = `
 
       Allowed values: table, list, object, string
 
-   --response-format-header  | --rfh (boolean)
+   --response-format-header | --rfh (boolean)
 
       If \\"--response-format-type table\\" is specified, include the column headers in
       the output.
 
  GLOBAL OPTIONS
  --------------
 
-   --response-format-json  | --rfj (boolean)
+   --response-format-json | --rfj (boolean)
 
       Produce JSON formatted data from a command
 
-   --help  | -h (boolean)
+   --help | -h (boolean)
 
       Display help text
 
-   --help-examples  (boolean)
+   --help-examples (boolean)
 
       Display examples for all the commands in a group
 
-   --help-web  | --hw (boolean)
+   --help-web | --hw (boolean)
 
       Display HTML help in browser
 

__tests__/__integration__/cli/query/program/cli.query.program.integration.test.ts

@@ -10,23 +10,19 @@
 */
 
 // Test environment will be populated in the "beforeAll"
-import { ITestEnvironment } from "../../../../__src__/environment/doc/response/ITestEnvironment";
-import { TestEnvironment } from "../../../../__src__/environment/TestEnvironment";
-import { runCliScript } from "../../../../__src__/TestUtils";
+import { ITestEnvironment, TestEnvironment, runCliScript } from "@zowe/cli-test-utils";
+import { ITestPropertiesSchema } from "../../../../__src__/doc/ITestPropertiesSchema";
 
-let TEST_ENVIRONMENT: ITestEnvironment;
-let programName: string;
+let TEST_ENVIRONMENT: ITestEnvironment<ITestPropertiesSchema>;
 describe("ims query program", () => {
 
     // Create the unique test environment
     beforeAll(async () => {
         TEST_ENVIRONMENT = await TestEnvironment.setUp({
             testName: "query_program_command",
-            skipProperties: true,
-            installPlugin: true
+            installPlugin: true,
+            skipProperties: true
         });
-        // programName = TEST_ENVIRONMENT.systemTestProperties.ims.programName;
-        programName = "test-program";
     });
 
     afterAll(async () => {