feat: Introduce new npmExecuteTests step #5124

phgermanov · 2024-10-01T13:05:04Z

Changes

Tests
Documentation
ADR

CCFenner · 2024-10-02T07:02:42Z

resources/metadata/npmExecuteTests.yaml

+          - PARAMETERS
+          - STAGES
+          - STEPS
+        default: "npm install"


use npm clean-install

CCFenner · 2024-10-02T07:03:46Z

resources/metadata/npmExecuteTests.yaml

+          - STAGES
+          - STEPS
+        mandatory: true
+        default: "wdi5"


Above we expose the tool npm, here we don't. We should be consistent. default: "npm run wdi5"

CCFenner · 2024-10-02T07:05:22Z

resources/metadata/npmExecuteTests.yaml

+            type: e2e
+  containers:
+    - name: node
+      image: node:lts-buster


buster is a pretty old image. use a more recent one.

https://hub.docker.com/_/node

CCFenner · 2024-10-08T07:46:40Z

vars/npmExecuteTests.groovy

+    if (config.credentialsId) {
+        if (config.wdi5) {
+            credentials.add([type: 'usernamePassword', id: config.credentialsId, env: ['wdi5_username', 'wdi5_password']])
+        } else {
+            credentials.add([type: 'usernamePassword', id: config.credentialsId, env: ['e2e_username', 'e2e_password']])
+        }
+    }


We should avoid doing such special handling in the groovy. That way we will have no support for it in GHA / ADO.

So should we store those in Vault as well?

Something like:

{ "appSecrets": { "urls": [ { "url": "loocalhost:8080", "username": "some-username1", "password": "some-password1" }, { "url": "loocalhost:8080", "username": "some-username2", "password": "some-password2" } ], "username": "base-url-username", "password": "base-url-password" } }

CCFenner · 2024-10-08T10:36:32Z

cmd/getConfig.go

+		if configOptions.OpenFile == nil {
+			return stepConfig, errors.New("config: open file function not set")
+		}


looks unrelated

It is, but it's been missed in some old PR and it's a hard bug to catch, might add it as a new PR

CCFenner · 2024-10-08T10:56:57Z

resources/metadata/npmExecuteTests.yaml

+    params:
+      - name: installCommand
+        type: string
+        description: Command to be executed for installation. Defaults to `npm ci`.


I think the "defaults to" can be omitted as defaults are printed in the docs.

CCFenner · 2024-10-08T11:12:12Z

resources/metadata/npmExecuteTests.yaml

+      - name: onlyRunInProductiveBranch
+        type: bool
+        default: false
+        description: Boolean to indicate whether the step should only be executed in the productive branch or not.
+        scope:
+          - PARAMETERS
+          - STAGES
+          - STEPS
+      - name: productiveBranch
+        type: string
+        default: "main"
+        description: The branch used as productive branch.
+        scope:
+          - GENERAL
+          - PARAMETERS
+          - STAGES
+          - STEPS


Is that really needed? I would not make a simple step aware of where it's running. This should be part of the pipeline I would say.

resources/metadata/npmExecuteTests.yaml

CCFenner · 2024-10-08T11:12:51Z

resources/metadata/npmExecuteTests.yaml

+      - name: reports
+        type: reports
+        params:
+          - filePattern: "**/e2e-results.xml"


Is this a typical file pattern for WDI5?

I don't think you can provide report with wdi5

resources/metadata/npmExecuteTests.yaml

CCFenner · 2024-10-08T11:17:08Z

resources/metadata/npmExecuteTests.yaml

+          - STEPS
+        mandatory: true
+        default: "npm run wdi5"
+      - name: appSecrets


Name is misleading as it also contains the URLs

resources/metadata/npmExecuteTests.yaml

CCFenner · 2024-10-08T11:57:19Z

cmd/npmExecuteTests.go

+	prefix := "e2e"
+	if wdi5 {
+		prefix = "wdi5"
+	}


What about leaving this to the user by exposing a credentialEnvVarPrefix parameter?

CCFenner · 2024-10-08T11:58:24Z

cmd/npmExecuteTests.go

+	log.Entry().Infof("Running end to end tests for URL: %s", url)
+
+	// Execute the npm script
+	options := "--baseUrl=" + url


I guess this is tool specific and should be configurable or maybe expose as an env var as well?

CCFenner · 2024-10-08T11:59:28Z

cmd/npmExecuteTests.go

+
+	username := config.AppSecrets["username"].(string)
+	password := config.AppSecrets["password"].(string)
+	credentialsToEnv(username, password, isWdi5)


Are empty credentials working here..?

CCFenner · 2024-10-08T12:03:27Z

cmd/npmExecuteTests.go

+	if ok {
+		for _, urlRaw := range urlsRaw {
+			urlMap := urlRaw.(map[string]interface{})
+			url := urlMap["url"].(string)
+			appURLs[url] = AppURL{
+				URL:      url,
+				Username: urlMap["username"].(string),
+				Password: urlMap["password"].(string),
+			}
+		}
+	}


We can handle the single url case with the collection as well.

Suggested change

if ok {

for _, urlRaw := range urlsRaw {

urlMap := urlRaw.(map[string]interface{})

url := urlMap["url"].(string)

appURLs[url] = AppURL{

URL: url,

Username: urlMap["username"].(string),

Password: urlMap["password"].(string),

}

}

}

if ok {

for _, urlRaw := range urlsRaw {

urlMap := urlRaw.(map[string]interface{})

url := urlMap["url"].(string)

appURLs[url] = AppURL{

URL: url,

Username: urlMap["username"].(string),

Password: urlMap["password"].(string),

}

}

} else {

appURLs[url] = AppURL{

URL: config.BaseURL,

}

}

I think this complicates it a bit

CCFenner · 2024-10-08T12:04:53Z

cmd/npmExecuteTests.go

+		for _, urlRaw := range urlsRaw {
+			urlMap := urlRaw.(map[string]interface{})
+			url := urlMap["url"].(string)
+			appURLs[url] = AppURL{


The key is not used at all, so this could also be a list of AppUrL.

CCFenner · 2024-10-08T12:05:04Z

cmd/npmExecuteTests.go

+}
+
+func runNpmExecuteTests(config *npmExecuteTestsOptions, c command.ExecRunner) error {
+	type AppURL struct {


Suggested change

type AppURL struct {

type AppUnderTest struct {

Co-authored-by: Christopher Fenner <[email protected]>

CCFenner

Looks good so far, just one thing with the docs, that we should align.

CCFenner · 2024-12-20T17:33:27Z

vars/piperExecuteBin.groovy

@@ -78,6 +78,7 @@ void call(Map parameters = [:], String stepName, String metadataFile, List crede
                        try {
                            try {
                                credentialWrapper(config, credentialInfo) {
+                                    echo "CONFIG: ${defaultConfigArgs}, ${customConfigArg}"


Is this needed? We would see the values in the command anyways, no?

it was debug log, removed in a205ec9

CCFenner · 2024-12-20T17:34:13Z

test.md

What is this used for?

that shouldn't have been committed, removed in a205ec9

CCFenner · 2024-12-20T17:48:48Z

resources/metadata/npmExecuteTests.yaml

+          - STAGES
+          - STEPS
+        mandatory: true
+        default: "npm run wdi5"


I think we should be clear what our default tool is, if any. So I guess for WDI5 we need a sidecar, right?

added default sidecar: c215bac

phgermanov · 2025-01-02T11:24:21Z

/it-go

sonarqubecloud · 2025-01-03T10:37:26Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

phgermanov · 2025-01-03T10:37:46Z

/it-go

…ix-fix * origin/master: (36 commits) Revert changes done to release action (SAP#5228) Update release-go.yml (SAP#5227) Remove README and CONTRIBUTING files from release 3rd try (SAP#5226) fix(setupCommonPipelineEnvironment): handling tags from scm info (SAP#5219) Remove README and CONTRIBUTING files from release 2nd try (SAP#5225) [CxONE] Improve report: add Low findings; Proposed Not Exploitable state (SAP#5223) Remove README and CONTRIBUTING files from release (SAP#5221) fix(naming): Rename Trust Engine to System Trust (SAP#5217) abapEnvironmentAssemblePackages Check for Build Errors (SAP#5214) docs: fix npmExuceteTests documentation formatting issues (SAP#5218) feat: Introduce new npmExecuteTests step (SAP#5124) fix(cloudFoundryDeploy): argument list too long (SAP#5216) Revert "Fix deployment failure with CF if password contains special char (SAP#5197)" (SAP#5215) chore(trustengine): Rename Trust Engine to System Trust in logs and docs (SAP#5210) Fix deployment failure with CF if password contains special char (SAP#5197) Update go version to 1.23 and removed some helper methods in favor of STD library (SAP#5200) Added validation for buildTool and buildDescriptorFile (SAP#5193) Unstash class files for Compliance stage (SAP#5192) (SAP#5204) fix(documentation): check param for jenkinsParams before appending Jenkins-specific text (SAP#5203) Align description of ADO and GHA (SAP#5202) ...

* origin/master: (36 commits) Revert changes done to release action (SAP#5228) Update release-go.yml (SAP#5227) Remove README and CONTRIBUTING files from release 3rd try (SAP#5226) fix(setupCommonPipelineEnvironment): handling tags from scm info (SAP#5219) Remove README and CONTRIBUTING files from release 2nd try (SAP#5225) [CxONE] Improve report: add Low findings; Proposed Not Exploitable state (SAP#5223) Remove README and CONTRIBUTING files from release (SAP#5221) fix(naming): Rename Trust Engine to System Trust (SAP#5217) abapEnvironmentAssemblePackages Check for Build Errors (SAP#5214) docs: fix npmExuceteTests documentation formatting issues (SAP#5218) feat: Introduce new npmExecuteTests step (SAP#5124) fix(cloudFoundryDeploy): argument list too long (SAP#5216) Revert "Fix deployment failure with CF if password contains special char (SAP#5197)" (SAP#5215) chore(trustengine): Rename Trust Engine to System Trust in logs and docs (SAP#5210) Fix deployment failure with CF if password contains special char (SAP#5197) Update go version to 1.23 and removed some helper methods in favor of STD library (SAP#5200) Added validation for buildTool and buildDescriptorFile (SAP#5193) Unstash class files for Compliance stage (SAP#5192) (SAP#5204) fix(documentation): check param for jenkinsParams before appending Jenkins-specific text (SAP#5203) Align description of ADO and GHA (SAP#5202) ...

…fig-fix * origin/master: (36 commits) Revert changes done to release action (SAP#5228) Update release-go.yml (SAP#5227) Remove README and CONTRIBUTING files from release 3rd try (SAP#5226) fix(setupCommonPipelineEnvironment): handling tags from scm info (SAP#5219) Remove README and CONTRIBUTING files from release 2nd try (SAP#5225) [CxONE] Improve report: add Low findings; Proposed Not Exploitable state (SAP#5223) Remove README and CONTRIBUTING files from release (SAP#5221) fix(naming): Rename Trust Engine to System Trust (SAP#5217) abapEnvironmentAssemblePackages Check for Build Errors (SAP#5214) docs: fix npmExuceteTests documentation formatting issues (SAP#5218) feat: Introduce new npmExecuteTests step (SAP#5124) fix(cloudFoundryDeploy): argument list too long (SAP#5216) Revert "Fix deployment failure with CF if password contains special char (SAP#5197)" (SAP#5215) chore(trustengine): Rename Trust Engine to System Trust in logs and docs (SAP#5210) Fix deployment failure with CF if password contains special char (SAP#5197) Update go version to 1.23 and removed some helper methods in favor of STD library (SAP#5200) Added validation for buildTool and buildDescriptorFile (SAP#5193) Unstash class files for Compliance stage (SAP#5192) (SAP#5204) fix(documentation): check param for jenkinsParams before appending Jenkins-specific text (SAP#5203) Align description of ADO and GHA (SAP#5202) ...

feat: Introduce new npmExecuteTests step

da9d73b

phgermanov requested a review from a team as a code owner October 1, 2024 13:05

phgermanov requested review from anilkeshav27 and CCFenner October 1, 2024 13:06

Philip Germanov and others added 8 commits October 1, 2024 16:08

fix: comma

20e00eb

fix: parens

f24b876

fix: error handling

7cadbf8

fix: paren

221840f

fix: config keys

17f0810

fix: rename key

0dc2cee

Merge branch 'master' into phgermanov/npm-execute-tests-go

49d42fb

test: failng tests

47ca127

CCFenner reviewed Oct 4, 2024

View reviewed changes

Philip Germanov and others added 5 commits October 4, 2024 10:57

fix: handle empty openFile call

187d850

refactor: clean install rather than install

aeef66b

refactor: full run command in config

56dfffe

build: use lts-bookworm

65f7cba

Merge branch 'master' into phgermanov/npm-execute-tests-go

20f05d8

phgermanov requested a review from CCFenner October 4, 2024 08:12

CCFenner reviewed Oct 8, 2024

View reviewed changes

Philip Germanov added 3 commits October 8, 2024 13:05

feat: get credentials from vault

045b530

feat: remove wdi5 install script

6bf1d06

fix: groovy tests

64f063f

CCFenner reviewed Oct 8, 2024

View reviewed changes

phgermanov and others added 5 commits October 8, 2024 15:28

fix: report type

f67b7a8

Co-authored-by: Christopher Fenner <[email protected]>

docs: remove defaults from desc

8e4ba08

feat: remove branch params

1a3e5ea

refactor: rename appSecrets to vaultMetadata

c22d874

feat: param for custom env var prefix

8c2456d

Philip Germanov added 16 commits December 4, 2024 15:13

chore: log current directory

14f1527

chore: fix log

c778adf

test: debug log

51548a4

fix: cnange workdir param

d1ac1e7

fix: default workdir

ce98cff

test: add param

d7e4bc0

test: log config

636be4b

S C O P E

13a287e

chore: remove debug logs

52ed146

feat: add sidecar

4da465d

fix: sidecar config

d135127

fix: remove sidecar

9b637e2

feat: add placeholder sidecar

44754da

refactor: remove unnecessary logs

2766216

feat: defer credentials reset

2469441

docs: selenium grid

9aec770

CCFenner approved these changes Dec 23, 2024

View reviewed changes

Philip Germanov and others added 3 commits January 2, 2025 13:20

feat: add selenium image

c215bac

chore: remove debug log

a205ec9

Merge branch 'master' into phgermanov/npm-execute-tests-go

d768424

phgermanov removed the request for review from anilkeshav27 January 2, 2025 11:33

docs: add beta warning

6fc71b3

phgermanov merged commit 531a0b8 into master Jan 3, 2025
14 checks passed

phgermanov deleted the phgermanov/npm-execute-tests-go branch January 3, 2025 10:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Introduce new npmExecuteTests step #5124

feat: Introduce new npmExecuteTests step #5124

phgermanov commented Oct 1, 2024

CCFenner Oct 2, 2024

phgermanov Oct 4, 2024

CCFenner Oct 2, 2024 •

edited

Loading

phgermanov Oct 4, 2024

CCFenner Oct 2, 2024 •

edited

Loading

phgermanov Oct 4, 2024

CCFenner Oct 8, 2024

phgermanov Oct 8, 2024

phgermanov Oct 8, 2024 •

edited

Loading

CCFenner Oct 8, 2024

phgermanov Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

phgermanov Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

phgermanov Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner Oct 8, 2024

CCFenner left a comment

CCFenner Dec 20, 2024

phgermanov Jan 2, 2025

CCFenner Dec 20, 2024

phgermanov Jan 2, 2025

CCFenner Dec 20, 2024

phgermanov Jan 2, 2025

phgermanov commented Jan 2, 2025

sonarqubecloud bot commented Jan 3, 2025

phgermanov commented Jan 3, 2025

feat: Introduce new npmExecuteTests step #5124

feat: Introduce new npmExecuteTests step #5124

Conversation

phgermanov commented Oct 1, 2024

Changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CCFenner Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CCFenner Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phgermanov Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CCFenner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phgermanov commented Jan 2, 2025

sonarqubecloud bot commented Jan 3, 2025

Quality Gate passed

phgermanov commented Jan 3, 2025

CCFenner Oct 2, 2024 •

edited

Loading

CCFenner Oct 2, 2024 •

edited

Loading

phgermanov Oct 8, 2024 •

edited

Loading