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

nixos/suricata: Fix module and add to module-list #349826

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

felbinger
Copy link
Member

@felbinger felbinger commented Oct 19, 2024

I forgot to add the suricata module (#313671) to the modules-list, so it doesn't appear in the search.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@bjornfor
Copy link
Contributor

You might want to remove import = [ [...] ../modules/services/networking/suricata/default.nix ] from nixos/tests/suricata.nix (in a separate commit).

@felbinger felbinger force-pushed the suricata-option branch 3 times, most recently from 9521404 to 83c2bc9 Compare October 19, 2024 18:33
@felbinger felbinger force-pushed the suricata-option branch 2 times, most recently from 7b7a965 to 394ce02 Compare October 19, 2024 18:36
@bjornfor
Copy link
Contributor

Commit "nixos/suricata: add module to modules-list" is now doing a lot more. I suggest to break this PR down into these commits:

  1. Fix module
  2. Add module to module-list.nix
  3. Remove now unneeded module in nixosTests

@felbinger felbinger marked this pull request as ready for review October 19, 2024 18:56
@felbinger felbinger changed the title nixos/suricata: add module to modules-list nixos/suricata: Fix module and add to module-list Oct 19, 2024
@bjornfor
Copy link
Contributor

Please mind the order of commits. Each commit should be atomic and take the code from one working state to the next. Currently, the first commit would break the test.

@hax404
Copy link
Contributor

hax404 commented Oct 19, 2024

Copy link
Member

@SuperSandro2000 SuperSandro2000 left a comment

Choose a reason for hiding this comment

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

the description could be a bit more elaborate and more a full sentence but other than that looking good

Copy link
Member

@Ma27 Ma27 left a comment

Choose a reason for hiding this comment

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

You might want to remove import = [ [...] ../modules/services/networking/suricata/default.nix ] from nixos/tests/suricata.nix (in a separate commit).

WHy in a separate commit? This gives you one commit where the test doesn't evaluate.

the description could be a bit more elaborate and more a full sentence but other than that looking good

I don't think single-word descriptions are appropriate, agreed.


Also, I noticed that the module has some import-from-derivation which made me build erlang while evaluating nixos/release.nix. Please remove that as well.


Also I must wonder why this got merged in this state in the first place 🤔

nixos/tests/suricata.nix Show resolved Hide resolved
@bjornfor
Copy link
Contributor

You might want to remove import = [ [...] ../modules/services/networking/suricata/default.nix ] from nixos/tests/suricata.nix (in a separate commit).

WHy in a separate commit? This gives you one commit where the test doesn't evaluate.

I suggested a commit order here: #349826 (comment) (no breakage).

@felbinger felbinger force-pushed the suricata-option branch 2 times, most recently from 668e212 to 7d0dd56 Compare October 22, 2024 17:31
@felbinger
Copy link
Member Author

the description could be a bit more elaborate and more a full sentence but other than that looking good

I don't think single-word descriptions are appropriate, agreed.

Not quiet sure what to put in there yet. Some of them have good descriptions in https://docs.suricata.io/en/suricata-7.0.7/configuration/suricata-yaml.html, which I am going to adopt, but some of them aren't really documented that well.

@felbinger felbinger force-pushed the suricata-option branch 2 times, most recently from 1b5c54f to 15e3ae5 Compare October 26, 2024 14:29
@felbinger felbinger marked this pull request as ready for review October 26, 2024 14:41
@bjornfor
Copy link
Contributor

Commit nixos/suricata: add module to modules-list contains patch hunks that belong to the other (first) commit.

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

Successfully merging this pull request may close these issues.

5 participants