How to debug zowe cli code?

[JWaters02]

I am working on #2432 and would very much like to be able to breakpoint debug through the code. However I can't find any docs on this and can't figure it out.

Also, wondering how to put logging into a file that doesn't have it yet, and where to see that logging? I tried using the Imperative API logging as explained in the wiki but those docs seem to be very out of date. Also tried using log4js logger from imperative with Logger.getAppLogger, but can't find where those logs are actually being outputted.

Any help appreciated.

[t1m0thyj]

See https://github.com/zowe/zowe-cli/blob/master/docs/DevelopmentTips.md#debugging-in-vs-code for an example of VS Code debug configuration. You can replace args with any CLI command you want to run.

The default location of logs for Zowe CLI is ~/.zowe/logs. If you want to define a custom logging directory in a test script that calls Zowe SDKs, this should work to initialize a Zowe logger that writes to ./logs/app.log:

Logger.initLogger(LoggingConfigurer.configureLogger('.', {name: 'app'}));

[JWaters02]

Cheers, this works thanks. Btw is there a build command for only building the necessary parts of the zowe SDK, for example just the zos-files-for-zowe-sdk? Would hope for that to cut down build time between changes significantly. Cheers.

[t1m0thyj]

You can cd into a specific package dir (e.g. packages/zosfiles) and npm run build there to build only that package. Although typically this isn't necessary, I'd recommend just running npm run watch at the top level which will detect changes to source code and rebuild packages as needed.

[JWaters02]

I'll keep this in mind for next time, thanks so much

[JWaters02]

Also I am getting this error on the top of all test files in the repo when I open them:

Parsing error: ESLint was configured to run on `<tsconfigRootDir>/packages\zosfiles\__tests__\__system__\methods\search\Search.system.test.ts` using `parserOptions.project`: 
- <tsconfigRootDir>/tsconfig.json
- <tsconfigRootDir>/__tests__\tsconfig.json
However, none of those TSConfigs include this file. Either:
- Change ESLint's list of included files to not include this file
- Change one of those TSConfigs to include this file
- Create a new TSConfig that includes this file and include it in your parserOptions.project
See the typescript-eslint docs for more info: https://typescript-eslint.io/troubleshooting/typed-linting#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-fileeslint

I looked in the tsconfig.json files (for example this one in packages/zosfiles/__tests__/) and saw that all test files are included, so not sure why it's saying that. For benefit of the doubt I added "packages/zosfiles/__tests__/__system__/methods/search/Search.system.test.ts" to the includes entry but still error there. So probably can't be that. Maybe the tsconfig.json file at the root of zowe-cli is overriding the inner one with its exclude on test files? The .eslintrc.js file seems fine to me.

[awharn]

You may need to add the following to your VSCode settings.json file:

"eslint.workingDirectories": [
        "packages/cli",
        "packages/core",
        "packages/imperative",
        "packages/provisioning",
        "packages/workflows",
        "packages/zosconsole",
        "packages/zosfiles",
        "packages/zosjobs",
        "packages/zoslogs",
        "packages/zosmf",
        "packages/zostso",
        "packages/zosuss",
    ],

This is because the ESLint VSCode Extension seems to only look in the workspace root directory for the TSConfig and ESLint configuration files, yet we have TSConfig files in every package directory. Alternatively, linting can be done from the command line with no issue, but the 'problems' will still appear in VSCode as long as the ESLint extension is enabled.

[JWaters02]

Thanks it works

[JWaters02]

I am trying to use the JestRunner extension as suggested, but when I click "Run" or "Debug" on a test case, I get the following error:

PS F:\Github Projects\Work\zowe-cli>  f:; cd 'f:\Github Projects\Work\zowe-cli'; ${env:NODE_OPTIONS}=' --require "c:/Users/Bobby/AppData/Local/Programs/Microsoft VS Code/resources/app/extensions/ms-vscode.js-debug/src/bootloader.js"  --inspect-publish-uid=http'; ${env:VSCODE_INSPECTOR_OPTIONS}=':::{"inspectorIpc":"\\\\.\\pipe\\node-cdp.25976-28a7f354-52.sock","deferredMode":false,"waitForDebugger":"","execPath":"C:\\Program Files\\nodejs\\node.exe","onlyEntrypoint":false,"autoAttachMode":"always","fileCallback":"C:\\Users\\Bobby\\AppData\\Local\\Temp\\node-debug-callback-4114f45d16a89703"}'; & 'C:\Program Files\nodejs\node.exe' 'node_modules/.bin/jest' 'f:/Github Projects/Work/zowe-cli/packages/zosfiles/__tests__/__unit__/methods/search/Search.unit.test.ts' '-t' 'Search searchLocal searchLocal - regular expression Should return a list of members that contain matches on the number search term \(all\)' '--runInBand' e-cli/packages/zosfiles/__tests__/__unit__/methods/search/Search.unit.test.ts' '-t' 'Search searchLocal searchLocal - regular expression Should return a list of members that contain matches on the number search term \x5c(all\x5c)' '--runInBand' 
Debugger attached.
Waiting for the debugger to disconnect...
F:\Github Projects\Work\zowe-cli\node_modules\.bin\jest:2
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
          ^^^^^^^

SyntaxError: missing ) after argument list
    at internalCompileFunction (node:internal/vm:77:18)
    at wrapSafe (node:internal/modules/cjs/loader:1288:20)
    at Module._compile (node:internal/modules/cjs/loader:1340:27)
    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
    at Module.load (node:internal/modules/cjs/loader:1207:32)
    at Module._load (node:internal/modules/cjs/loader:1023:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:135:12)
    at node:internal/main/run_main_module:28:49

Node.js v20.11.1

The extension says it should work OOTB with a valid jest config, but there are some settings that can be changed. As I'm unfamiliar with zowe cli test environment, is there any settings I need to change to get it to work?

Cheers

[t1m0thyj]

On MacOS the Jest Runner extension works for me OOTB. Based on the error message, It seems like on Windows it fails to parse the Bash script at node_modules/.bin/jest.

Perhaps changing the "Jestrunner: Jest Path" setting in VS Code to point directly to the node_modules/jest/bin/jest.js file would help?

[JWaters02]

Thanks that works