Fix merging of profile properties in `ProfileInfo.createSession` #1010

t1m0thyj · 2023-08-28T22:07:08Z

What It Does
Fixes #1008 so that user and password takes precedence over tokenValue when both are defined in profile properties.

How to Test

Create a team config file that has both user/password and tokenValue defined (such as the example provided in the linked issue).
Call ProfileInfo.createSession (using a test script like the one below) and verify that only user/password are present in the session.

const { ProfileInfo } = require("@zowe/imperative");
(async () => {
    // Load connection info from default z/OSMF profile
    const profInfo = new ProfileInfo("zowe");
    await profInfo.readProfilesFromDisk();
    const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf");
    const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true });
    const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs);
    console.dir(session.ISession);
})();

Review Checklist
I certify that I have:

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

Additional Comments
There is logic in ConnectionPropsForSessCfg.resolveSessCfgProps to conditionally add either user/password or tokenValue to the session. But this logic only runs when user, password, and tokenValue are passed in cmdArgs instead of the sessCfg object. The fix implemented in this PR is consistent with how Zowe CLI command handlers resolve the properties - for example the ZosFilesBaseHandler.

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

codecov · 2023-08-28T22:18:26Z

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.01% ⚠️

Comparison is base (267ffe8) 89.77% compared to head (22b55e1) 89.76%.
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1010      +/-   ##
==========================================
- Coverage   89.77%   89.76%   -0.01%     
==========================================
  Files         211      211              
  Lines       11536    11538       +2     
  Branches     2586     2587       +1     
==========================================
+ Hits        10356    10357       +1     
- Misses       1180     1181       +1