Profile API merge error

[jace-roell]

What It Does
Resolves an issue where team config base profiles were being overwritten if a user config did not have a base profile.

How to Test
See attached issue for details.

Example Config Files:

zowe.config.user.json:

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "zosmf": {
            "type": "zosmf",
            "properties": {
                "port": <port>
            }
        }
    },
    "defaults": {},
    "autoStore": true
}

zowe.config.json:

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "zosmf":{
            "type": "zosmf",
            "properties": {
                "user": <user>,
                "password": <password>
            }
        },
        "global_base": {
            "type": "base",
            "properties": {
                "host": <host>,
                "rejectUnauthorized": false
            }
        }
    },
    "defaults": {
        "zosmf": "zosmf",
        "tso": "tso",
        "ssh": "ssh",
        "base": "global_base"
    },
    "autoStore": false
}

Review Checklist
I certify that I have:

• tested my changes
• added/updated automated tests
• updated the changelog
• followed the contribution guidelines

Additional Comments

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.28%. Comparing base (5b85f22) to head (95a3fdd).
Report is 20 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2383   +/-   ##
=======================================
  Coverage   91.27%   91.28%           
=======================================
  Files         638      638           
  Lines       18190    18207   +17     
  Branches     3888     3822   -66     
=======================================
+ Hits        16603    16620   +17     
  Misses       1586     1586           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

📅 Suggested merge-by date: 12/27/2024

[traeok]

Changes and tests LGTM - I tested this alongside Zowe Explorer and its working as expected. Thanks for the fix Jace!

Without fix:

With fix:

[gejohnston]

@jace-roell A user config merges differently when both config files are at the same level (profiles are merged property-by-property) than when one profile is global and one profile is in a project directory (the entire profile is replaced). Details are documented here:

zowe-cli/docs/How_config_files_are_merged.md

Have you manually tested such combinations to confirm that they all work as intended?

[zFernand0]

In practice the properties seems to be loaded in accordance with the document that Geneshared:

• See using-a-global-team-config-and-a-global-user-config

Using the script below

/* Save this file as `test.mjs` and run `node test.mjs` */

import { ProfileInfo } from "@zowe/imperative";
import * as util from "util";
(async () => {
    const profInfo = new ProfileInfo("zowe");
    await profInfo.readProfilesFromDisk();
    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
    console.log("Known args: ", util.inspect(zosmfMergedArgs.knownArgs, {depth: 3, colors: true}))
})().catch((err) => {
    console.error(err);
    process.exit(1);
});

I can see the following outputs:

• On `prof-info-api-fail` - rejectUnathorized is merged according to the document

  zFernand0 @ Mac (arm64) ~/gh/zowe/cli.master                                                                          [15:39:25]
  > $ node test.mjs                                                                            ⬡ system [±prof-info-api-fail ●(✹)]
      Known args:  [
        {
          argName: 'port',
          dataType: 'number',
          argValue: 1234,
          argLoc: {
            locType: 1,
            osLoc: [ '/Users/zFernand0/.zowe/zowe.config.user.json' ],
            jsonLoc: 'profiles.zosmf.properties.port'
          },
          secure: false,
          inSchema: true
        },
        {
          argName: 'rejectUnauthorized',
          dataType: 'boolean',
          argValue: false,
          argLoc: {
            locType: 1,
            osLoc: [ '/Users/zFernand0/.zowe/zowe.config.user.json' ],
            jsonLoc: 'profiles.base.properties.rejectUnauthorized'
          },
          secure: false,
          inSchema: true
        }
      ]

• On Master (rejectUnathorized is not merged according to the document)

  zFernand0 @ Mac (arm64) ~/gh/zowe/cli.master                                                                          [15:39:25]
  > $ node test.mjs                                                                                        ⬡ system [±master ●(✹)]
      Known args:  [
        {
          argName: 'port',
          dataType: 'number',
          argValue: 1234,
          argLoc: {
            locType: 1,
            osLoc: [ '/Users/zFernand0/.zowe/zowe.config.user.json' ],
            jsonLoc: 'profiles.zosmf.properties.port'
          },
          secure: false,
          inSchema: true
        }
      ]

---

The reason for the requested changes is that is you look closely, the osLoc for rejecjectUnauthorized is pointing to the global user config instead of where it came from (the global regular/non-user config). Having a wrong osLoc value may cause other issues in the future if properties need to be updated. I believe we go to that osLoc and update them. Then, attempting to update the rejectUnauthorized value may result in a new base profile being created in the config.user.json file 😋

---

And yeah, my configs are as simple as:

`zowe.config.user.json`

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "zosmf": {
            "type": "zosmf",
            "properties": {
                "port": 1234
            },
            "secure": []
        }
    },
    "defaults": {
        "zosmf": "zosmf"
    },
    "autoStore": true
}

`zowe.config.json`

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "base": {
            "type": "base",
            "properties": {
                "rejectUnauthorized": false
            },
            "secure": []
        }
    },
    "defaults": {
        "base": "base"
    },
    "autoStore": true
}

[anaxceron]

Suggesting some edits to the changelog entry

[anaxceron]

nice changelog @jace-roell!

resolved

[zFernand0]

There are some lint warnings regarding indentation after removing the if/else login for the osLocInfo 😋
https://github.com/zowe/zowe-cli/actions/runs/12394840626/job/34599196199?pr=2383#step:5:44

But other than that, this PR LGTM! 😋

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
85.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

Release succeeded for the master branch. 🎉

The following packages have been published:

• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]
• npm: @zowe/[email protected]

_{Powered by Octorelease 🚀}