Skip to content

Comments

Feature/248 refactor project structure#262

Merged
MaartendeKruijf merged 40 commits intodevelopmentfrom
feature/248-refactor-project-structure
Dec 2, 2024
Merged

Feature/248 refactor project structure#262
MaartendeKruijf merged 40 commits intodevelopmentfrom
feature/248-refactor-project-structure

Conversation

@MaartendeKruijf
Copy link
Collaborator

No description provided.

@MaartendeKruijf MaartendeKruijf self-assigned this Nov 22, 2024
@MaartendeKruijf MaartendeKruijf linked an issue Nov 22, 2024 that may be closed by this pull request
@github-actions
Copy link

github-actions bot commented Nov 22, 2024

Sigrid maintainability feedback

✅ You wrote maintainable code and achieved your Sigrid objective of 1.0 stars

Show details

Sigrid compared your code against the baseline of 2024-11-22.

👍 What went well?

You fixed or improved 0 refactoring candidates.

👎 What could be better?

Unfortunately, 166 refactoring candidates were introduced or got worse.

Risk System property Location
🔴 Duplication
(Introduced)
pkg/utils/stix/expression/comparison/comparison.go (lines 152-171)
pkg/utils/stix/expression/comparison/comparison.go (lines 183-202)
🔴 Duplication
(Introduced)
pkg/utils/stix/expression/comparison/comparison.go (lines 213-223)
pkg/utils/stix/expression/comparison/comparison.go (lines 322-333)
🔴 Duplication
(Introduced)
internal/validators/json.go (lines 13-26)
pkg/models/validator/schema.go (lines 42-55)
🔴 Duplication
(Introduced)
pkg/models/cacao/cacao.go (lines 280-292)
pkg/models/decoder/decoder.go (lines 50-62)
🔴 Duplication
(Introduced)
pkg/utils/stix/expression/comparison/comparison.go (line 213-220)
pkg/utils/stix/expression/comparison/comparison.go (line 322-330)
pkg/utils/stix/expression/comparison/comparison.go (line 183-191)
+ 1 occurrences
🔴 Duplication
(Introduced)
pkg/core/capability/openc2/openc2.go (lines 42-48)
pkg/core/capability/powershell/powershell.go (lines 48-54)
🔴 Duplication
(Introduced)
pkg/core/capability/controller/controller.go (lines 104-110)
pkg/core/capability/controller/controller.go (lines 132-138)
🔴 Duplication
(Introduced)
pkg/integration/thehive/reporter/thehive_connector.go (lines 131-137)
pkg/integration/thehive/reporter/thehive_connector.go (lines 70-76)
⚫️ + 158 more

📚 Remaining technical debt

0 refactoring candidates didn't get better or worse, but are still present in the code you touched.

View this system in Sigrid** to explore your technical debt

⭐️ Sigrid ratings

System property System on 2024-11-22 Before changes New/changed code
Volume 5.4 N/A N/A
Duplication 4.4 N/A 4.4
Unit Size 2.5 N/A 2.9
Unit Complexity 2.6 N/A 2.6
Unit Interfacing 2.4 N/A 2.4
Module Coupling 3.8 N/A 3.8
Component Independence 5.4 N/A N/A
Component Entanglement 2.4 N/A N/A
Maintainability 3.7 N/A 3.3

Did you find this feedback helpful?

We would like to know your thoughts to make Sigrid better.
Your username will remain confidential throughout the process.


View this system in Sigrid

@MaartendeKruijf MaartendeKruijf force-pushed the feature/248-refactor-project-structure branch from 27aff16 to 08f70ae Compare November 24, 2024 12:50
@MaartendeKruijf
Copy link
Collaborator Author

Reporting docs will be updated in #235

Copy link
Collaborator

@lucamrgs lucamrgs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really nice to me, thanks for this!
I have just pointed out one small typo in the docs, and a suggestion to move integration/thehive/reporter/ids_map.go to integration/thehive/common


### Controller
The SOARCA controller will create all classed needed by SOARCA. The controller glues the endpoints and decomposer together. Each run will instantiate a new decomposer.
The SOARCA controller will create all classed needed by SOARCA. The controller glues the api and decomposer together. Each run will instantiate a new decomposer.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: ...will create all classeS

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could go in the "common" directory, since probably a manual step implementation would also use the ids map

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so too but I don't want to change the code at this point

Copy link
Collaborator

@lucamrgs lucamrgs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good with me!

@MaartendeKruijf MaartendeKruijf merged commit 8fc5345 into development Dec 2, 2024
@MaartendeKruijf MaartendeKruijf deleted the feature/248-refactor-project-structure branch December 2, 2024 14:09
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 this pull request may close these issues.

Refactor project structure

3 participants