Use binaries for CI testing 😋

[zFernand0]

Things included here:

• Ability to run all integrations tests in Daemon mode
• Ability to run GitHub actions locally using nektos/act

Issues fixed:

• Daemon Mode tests for rust binary on Windows, Linux, Mac #1177
• Daemon Mode - Full suite of rust executable tests #1183

Known Test Failures:

• Integration: Checking for stderr will fail.
  Daemon Mode - Erros from the daemon are not forwarded through STDERR #1195
• Integration: Mac testing will fail.
  Daemon Mode - Socket connection error after every command [Mac-only] #1192

[codecov]

Codecov Report

Merging #1196 (407e844) into next (705c1bf) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             next    #1196   +/-   ##
=======================================
  Coverage   91.67%   91.67%           
=======================================
  Files         356      356           
  Lines        5478     5478           
  Branches      773      773           
=======================================
  Hits         5022     5022           
  Misses        451      451           
  Partials        5        5           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 06330fa...407e844. Read the comment docs.

[zFernand0]

Here is an example of how the matrix will be handled by nektos/act

Testing: (notice the colors on the left side) 😋

[zFernand0]

The zowe-cli.yml workflow may need to be renamed in order for the workflow_dispatch (and default values for its inputs) to take effect

[gejohnston]

Just a couple of questions to complete my understanding. I am NOT requesting any changes.

[gejohnston]

Nektos/act doc implies that it runs on windows. Is your statement due to the fact that nektos/act only hosts Linux docker images?

[zFernand0]

That's right, I will rephrase that statement 👍
It should work fine on Windows, Linux, MacOS, and almost everywhere you can have Docker (e.g. Raspberry PI - armv7l) 😋

[gejohnston]

Should ./node_modules/.bin also be the location that the "zowe config daemon" command puts the zowe executable at a customer site?

[zFernand0]

I don't think ./node_modules/.bin will work for end users since the where/which zowe location depends on their installation/configuration of node and npm, e.g. using nvm.
For example:

• /root/.nvm/versions/node/v16.12.0/bin/zowe
• C:\Users\USER\scoop\apps\nvm\current\nodejs\nodejs\zowe
• C:\Users\USER\AppData\Roaming\npm\zowe

Maybe something along the lines of "${process.env.ZOWE_CLI_HOME}/_bin" or "~/.zowe/_bin")

[gejohnston]

Thanks. Makes sense. Many customers may not even have the privilege to write to those NodeJS locations when they run the "zowe config daemon" command.

[zFernand0]

Note:
The location where we place the binary changed from ./node_modules/.bin to ./__tests__/__resources__/application_instances becuase of the TestEnvironment.setUp function. (see below)

zowe-cli/__tests__/__src__/environment/TestEnvironment.ts

Line 43 in 06330fa

result.env.PATH = `${nodePath.resolve(__dirname, "../../__resources__/application_instances")}${separator}${process.env.PATH}`;

[zFernand0]

Even though binary is the default test-type, I believe that if: github.event.inputs.test-type == 'binary' will be skipped until master recognizes the workflow_dispatch event.

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

Lines 21 to 24 in c746e43

	test-type:
	description: "Specify whether to run tests using the `binary` or regular `nodejs` executable"
	default: 'binary'
	required: false

[zFernand0]

Note:
The following hack was necessary for the binary to be recognized.
result.env.PATH = `${process.env.PATH}${separator}${nodePath.resolve(__dirname, "../../__resources__/application_instances")}`;

Which means that the setup-binary step will need to be changed back to modifying the path instead of relying on the ./node_modules/.bin location to be recognized by the integration tests

  run: |
    mkdir -p $HOME/.zowe/_bin
    tar -xvzf zowe.tgz -C $HOME/.zowe/_bin
    echo "$HOME/.zowe/_bin" >> $GITHUB_PATH

[t1m0thyj]

@zFernand0 Thanks for addressing all of my feedback related to the test:act script 🙂

Left a minor comment below, also I'm still having issues with using nektos/act locally 😢 Lots of integration tests fail with an error like the following:

Expected: ""
Received: "/mnt/c/Users/XXX/Projects/zowe-next/zowe-cli/packages/cli/__tests__/zostso/__integration__/issue/__scripts__/issue_help.sh: 2: set: Illegal option -·
"

Based on some Google searching, the error set: Illegal option -· seems to be caused by Bash scripts using Windows line endings (CRLF) instead of Unix ones (LF). I believe what is happening is that on my local machine, the Bash scripts are checked out with CRLF line endings, and then they're getting copied into the Ubuntu Docker container.

Curious what solution you would suggest here - should I change Git settings on my Windows machine to check out files with Unix line endings, or is there an easy way we can convert the line endings when files are copied into the Docker container?

[t1m0thyj]

LGTM! Moved my comment above to #1210 so that it can be addressed separately instead of holding up this PR 🙂

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information