feat(imperative): Enhanced ProfileInfo.updateProperty

[zFernand0]

What It Does

• Add a forceUpdate optional property to the ProfileInfo.updateProperty method.
  • This property only works on V2 config files

How to Test

Check out the GIF at the bottom 😋
OR

• Modify a property in a service profile that originally comes from a base profile (e.g. tokenType, tokenValue)
  • With forceUpdate: false: the base profile is updated
  • With forceUpdate: true: the apiml profile is updated

Use this config file for testing purposes

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "apiml": {
            "type": "zosmf",
            "properties": {
                "basePath": "/ibmzosmf/api/v1/"
            }
        },
        "base": {
            "type": "base",
            "properties": {
                "tokenType": "apimlAuthenticationToken"
            }
        }
    },
    "defaults": {
        "zosmf": "apiml",
        "base": "base"
    },
    "autoStore": true
}

Use this little test.mjs script for testing purposes

import { ProfileInfo } from "@zowe/imperative";
(async () => {
    const profInfo = new ProfileInfo("zowe");
    await profInfo.readProfilesFromDisk();
    await profInfo.updateProperty({
      profileName: "apiml", 
      profileType: "zosmf",
      property: "tokenType", 
      value: "test",
      forceUpdate: false
    })
})().catch((err) => {
    console.error(err);
    process.exit(1);
});

Review Checklist
I certify that I have:

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

Additional Comments

This is intended to help with the implementation of:

• Allow extenders to authenticate to APIML without having to contribute a common API zowe-explorer-vscode#2493

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (599f6b3) 91.03% compared to head (7dd5a40) 91.03%.
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1983   +/-   ##
=======================================
  Coverage   91.03%   91.03%           
=======================================
  Files         636      636           
  Lines       18713    18718    +5     
  Branches     3898     3900    +2     
=======================================
+ Hits        17035    17040    +5     
  Misses       1677     1677           
  Partials        1        1           

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

[traeok]

Everything looks good - just left a small request below 😋
Thanks @zFernand0!

[traeok]

thanks for quickly addressing that @zFernand0 😁 LGTM

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

92.3% Coverage
0.0% Duplication

[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 🚀}