Slight refactor of scbctl by ddddddO · Pull Request #2682 · secureCodeBox/secureCodeBox

ddddddO · 2024-09-27T14:05:55Z

Description

Refactor scbctl👍!

Remove extra processing in scbctl cmd's buildTree function ( 80f408b )

Replace Map to Slice ( 1e1ac14 )

Golang's map does not guarantee ordering, so I changed it from a map to a slice so that the result of each execution is the same each time.
I think it will solve the problem.

The following is a log of multiple runs of go test before and after the change at local.

Before

ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.027s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.021s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.019s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.020s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
--- FAIL: TestBuildTree (0.00s)
    --- FAIL: TestBuildTree/Complex_cascade (0.00s)
        cascading_test.go:125: 
                Error Trace:    /home/ddddddo/github.com/ddddddO/secureCodeBox/scbctl/cmd/cascading_test.go:125
                Error:          Not equal: 
                                expected: "Scans\n└── root\n    ├── child1\n    │   └── grandchild\n    └── child2\n"
                                actual  : "Scans\n└── root\n    ├── child2\n    └── child1\n        └── grandchild\n"
                            
                                Diff:
                                --- Expected
                                +++ Actual
                                @@ -2,5 +2,5 @@
                                 └── root
                                -    ├── child1
                                -    │   └── grandchild
                                -    └── child2
                                +    ├── child2
                                +    └── child1
                                +        └── grandchild
                                 
                Test:           TestBuildTree/Complex_cascade
🆕 Creating a new scan with name 'nmap' and parameters 'scanme.nmap.org'
🚀 Successfully created a new Scan 'nmap'
🆕 Creating a new scan with name 'nmap' and parameters 'scanme.nmap.org -p 90'
🚀 Successfully created a new Scan 'nmap'
🆕 Creating a new scan with name 'scanme-nmap-org' and parameters 'scanme.nmap.org'
🚀 Successfully created a new Scan 'scanme-nmap-org'
🆕 Creating a new scan with name 'nmap' and parameters 'scanme.nmap.org'
🚀 Successfully created a new Scan 'nmap'
🆕 Creating a new scan with name 'kubeaudit' and parameters '--namespace some-other-namespace'
🚀 Successfully created a new Scan 'kubeaudit'
Error: you must use '--' to separate scan parameters
Error: you must use '--' to separate scan parameters
triggered new Scan for ScheduledScan 'nmap'
Error: could not find ScheduledScan 'nonexistent-scan' in namespace 'foobar'
Error: accepts 1 arg(s), received 0
triggered new Scan for ScheduledScan 'nmap'
FAIL
FAIL    github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.025s
FAIL
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$

↓

After

ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.019s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.019s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.025s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.023s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.017s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.025s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.019s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.034s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.019s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.021s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.023s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.022s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.024s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.020s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.018s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.026s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./... -count=1
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       0.021s
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$

Checklist

Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.

ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$ go test ./...
ok      github.com/secureCodeBox/secureCodeBox/scbctl/cmd       (cached)
ddddddo@debian:~/github.com/ddddddO/secureCodeBox/scbctl/cmd$

Make sure that all your commits are signed-off and that you are added to the Contributors file.
Make sure that all CI finish successfully.
Optional (but appreciated): Make sure that all commits are Verified.

netlify · 2024-09-27T14:06:11Z

✅ Deploy Preview for docs-securecodebox canceled.

Name	Link
🔨 Latest commit	`e910103`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-securecodebox/deploys/66f8192314f6480008aea9ae

Signed-off-by: ddddddO <[email protected]>

ddddddO · 2024-09-28T01:25:07Z

@J12934
Hi!
Please review this pull request as I think it will resolve this problem👍

ddddddO · 2024-09-28T09:12:26Z

fyi @Freedisch

Hi!
I have made a few changes to the source code🙇

J12934 · 2024-09-28T14:44:37Z

Hi @ddddddO

Thank you for taking a deeper look at this 🙌

Can you add yourself to the contributors file: https://github.com/secureCodeBox/secureCodeBox/blob/main/CONTRIBUTORS.md

Then we should be ready to merge 😊

Signed-off-by: ddddddO <[email protected]>

sonarqubecloud · 2024-09-28T14:57:43Z

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 SonarCloud

ddddddO · 2024-09-28T14:59:18Z

@J12934

Thanks for the review!
And thanks for putting my name on the CONTRIBUTORS.md even though it is a small code change!

J12934 · 2024-09-28T18:47:35Z

The nikto test failures like 99.99% unrelated to this. Will try restarting it, will take a look at them if that doesn't help

ddddddO · 2024-09-29T00:20:23Z

~~It looks like this test is not failing on any commit other than this PullRequest... It's a mystery...~~

Any other PullRequest ci that is also failing😵
https://github.com/secureCodeBox/secureCodeBox/actions/runs/11082815384

It appears that this test (nikto test) has been failing recently.
I checked the first page of the list of failed GitHubActions below:
https://github.com/secureCodeBox/secureCodeBox/actions?query=is%3Afailure

Sorry I have no idea 🙇, but there has been a recent change in sullo/nikto (commits since sullo/nikto@890e895?), so maybe that has something to do with it.

J12934 · 2024-09-30T04:58:13Z

@ddddddO had a look regarding the nikto issues :)
Think i found a workaround: #2685

ddddddO · 2024-09-30T05:18:04Z

@J12934
Excellent🎉! Thank you!

J12934 · 2024-09-30T18:37:55Z

Ok build now went through after a second fix 😊

Merge the PR now. Thanks again for the contribution and the patience 😅

ddddddO · 2024-10-01T00:06:09Z

I saw sullo/nikto#843 👍 Thank you very much!

[nits] modify buildTree func

80f408b

Signed-off-by: ddddddO <[email protected]>

ddddddO force-pushed the slight_change_building_tree_of_scbctl branch from 3ae6971 to 80f408b Compare September 27, 2024 14:39

replace map to slice

1e1ac14

Signed-off-by: ddddddO <[email protected]>

ddddddO changed the title ~~Remove extra processing in scbctl cmd's buildTree function~~ Slight refactor of scbctl Sep 27, 2024

add name on CONTRIBUTORS.md

e910103

Signed-off-by: ddddddO <[email protected]>

J12934 approved these changes Sep 30, 2024

View reviewed changes

J12934 merged commit a2f3028 into secureCodeBox:main Sep 30, 2024

ddddddO deleted the slight_change_building_tree_of_scbctl branch October 1, 2024 11:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Slight refactor of scbctl#2682

Slight refactor of scbctl#2682
J12934 merged 3 commits intosecureCodeBox:mainfrom
ddddddO:slight_change_building_tree_of_scbctl

ddddddO commented Sep 27, 2024 •

edited

Loading

Uh oh!

netlify bot commented Sep 27, 2024 •

edited

Loading

Uh oh!

ddddddO commented Sep 28, 2024 •

edited

Loading

Uh oh!

ddddddO commented Sep 28, 2024

Uh oh!

J12934 commented Sep 28, 2024

Uh oh!

sonarqubecloud bot commented Sep 28, 2024

Uh oh!

ddddddO commented Sep 28, 2024

Uh oh!

J12934 commented Sep 28, 2024

Uh oh!

ddddddO commented Sep 29, 2024 •

edited

Loading

Uh oh!

J12934 commented Sep 30, 2024

Uh oh!

ddddddO commented Sep 30, 2024

Uh oh!

J12934 commented Sep 30, 2024

Uh oh!

ddddddO commented Oct 1, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ddddddO commented Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

netlify bot commented Sep 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-securecodebox canceled.

Uh oh!

ddddddO commented Sep 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ddddddO commented Sep 28, 2024

Uh oh!

J12934 commented Sep 28, 2024

Uh oh!

sonarqubecloud bot commented Sep 28, 2024

Quality Gate passed

Uh oh!

ddddddO commented Sep 28, 2024

Uh oh!

J12934 commented Sep 28, 2024

Uh oh!

ddddddO commented Sep 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

J12934 commented Sep 30, 2024

Uh oh!

ddddddO commented Sep 30, 2024

Uh oh!

J12934 commented Sep 30, 2024

Uh oh!

ddddddO commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ddddddO commented Sep 27, 2024 •

edited

Loading

netlify bot commented Sep 27, 2024 •

edited

Loading

ddddddO commented Sep 28, 2024 •

edited

Loading

ddddddO commented Sep 29, 2024 •

edited

Loading

ddddddO commented Oct 1, 2024 •

edited

Loading