Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting started doc requirements #2743

Closed
expp121 opened this issue Dec 8, 2023 · 0 comments · Fixed by #2744
Closed

Update getting started doc requirements #2743

expp121 opened this issue Dec 8, 2023 · 0 comments · Fixed by #2744

Comments

@expp121
Copy link
Contributor

expp121 commented Dec 8, 2023

Problem

Currently, the script in section 1.2.4:
image

Requires jq (JSON processor) to function properly. When running the script without having jq installed, you get the following output:

user@user:~/x/y/sechub$ ./sechub-solution/setup-pds/setup-gosec.sh


### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
user: gosec
project: test-gosec
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
8900-helper.sh: line 9: jq: command not found
Adding user: gosec
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
HTTP/1.1 200 

### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
HTTP/1.1 201 

### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
8900-helper.sh: line 9: jq: command not found
Creating project test-gosec.
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
{ "apiVersion":"1.0", "name":"test-gosec", "owner":"gosec", "description":"Created by sechub-api.sh at 2023-12-08 11:18 CET" }
HTTP/1.1 201 

### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.


### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
./8801-create-executor-and-profile.sh: line 44: jq: command not found
8900-helper.sh: line 9: jq: command not found
Profile pds-gosec already exists.
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
project: test-gosec
profile: pds-gosec
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
./8802-assign-profile-to-project.sh: line 37: jq: command not found
8900-helper.sh: line 9: jq: command not found
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.
8900-helper.sh: line 9: jq: command not found
### Hint: Install jq (https://github.com/stedolan/jq). Now executor access by name will not work.


Assigned profile pds-gosec to project test-gosec

Setup of GoSec complete:

- user: gosec
- project: test-gosec

sechub -project test-gosec scan

compared to the expected output:

user: gosec
project: test-gosec
Adding user: gosec
HTTP/1.1 200
HTTP/1.1 201
Creating project test-gosec.
{
  "apiVersion": "1.0",
  "name": "test-gosec",
  "owner": "gosec",
  "description": "Created by sechub-api.sh at 2023-01-01 12:00 CET"
}
HTTP/1.1 201
{
  "configurations": [
    {
      "uuid": "d23dc9ab-4a3d-4924-8d77-8026069cbd91"
    }
  ],
  "description": "Created by sechub-api.sh at 2023-01-01 12:00 CET",
  "enabled": true
}
HTTP/1.1 201
{
  "id": "pds-gosec",
  "description": "Created by sechub-api.sh at 2023-01-01 12:00 CET",
  "enabled": true,
  "configurations": [
    {
      "name": "pds-gosec",
      "productIdentifier": "PDS_CODESCAN",
      "setup": {
        "baseURL": "https://pds-gosec:8444",
        "credentials": {
          "user": "techuser",
          "password": "pds-apitoken"
        },
        "jobParameters": [
          {
            "key": "pds.config.productidentifier",
            "value": "PDS_GOSEC"
          },
          {
            "key": "pds.config.use.sechub.storage",
            "value": "false"
          },
          {
            "key": "pds.mocking.disabled",
            "value": "true"
          },
          {
            "key": "sechub.productexecutor.pds.timeout.minutes",
            "value": "60"
          },
          {
            "key": "sechub.productexecutor.pds.timetowait.nextcheck.milliseconds",
            "value": "500"
          },
          {
            "key": "sechub.productexecutor.pds.trustall.certificates",
            "value": "true"
          }
        ]
      },
      "executorVersion": 1,
      "enabled": true,
      "uuid": "d23dc9ab-4a3d-4924-8d77-8026069cbd91"
    }
  ],
  "projectIds": []
}
Created executor and profile
project: test-gosec
profile: pds-gosec
Assigned profile pds-gosec to project test-gosec

Setup of GoSec complete:

- user: gosec
- project: test-gosec

Solution

We should add jq in the requirements sections of the tutorial

expp121 added a commit to expp121/sechub that referenced this issue Dec 8, 2023
* The script that sets up a Sechub project requires `jq` to properly display infromation

closes mercedes-benz#2743
Jeeppler pushed a commit that referenced this issue Dec 8, 2023
* The script that sets up a Sechub project requires `jq` to properly display infromation

closes #2743
haerter-tss pushed a commit that referenced this issue Dec 20, 2023
* The script that sets up a Sechub project requires `jq` to properly display infromation

closes #2743
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant