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

dockerTools: mark streamLayerdImage result as isExe #99375

Merged
merged 1 commit into from Oct 5, 2020

Conversation

roberth
Copy link
Member

@roberth roberth commented Oct 2, 2020

Motivation for this change

Allow build*Image and streamLayeredImage to be used interchangeably in code that supports both methods,
by streamImageCommand or by tools like arion.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)

  • Built on platform(s)

    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)

    • I have decided not to test every branch of the function in its own test case to keep the tests reasonably fast and focused. I did test it manually.
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"

  • Tested execution of all binary files (usually in ./result/bin/)

  • Determined the impact on package closure size (by running nix path-info -S before and after)

  • Ensured that relevant documentation is up to date

  • Fits CONTRIBUTING.md.

Copy link
Member

@utdemir utdemir left a comment

Choose a reason for hiding this comment

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

I can't say that I completely understand this PR. It seems like we're trying to achieve a kind of polymorphism. However, that doesn't seem very Nix-y to me; I don't see how that polymorphism would be more preferable over the old boring way of using two different functions to manipulate two different derivations.

However, since you do seem to have a need for it; I prefer not to explicitly approve or disapprove this PR, so with apologies, I prefer someone else to review it.

@roberth
Copy link
Member Author

roberth commented Oct 5, 2020

I agree that overly polymorphic code is a bad idea, so I've removed the extra function that wasn't quite necessary.

For compatibility, Arion supports both the stream and build variations. Adding only the isExe attribute makes that just a little bit more robust and it could be useful for some other application, particularly if their code doesn't control the expression that produces the image.

Copy link
Member

@utdemir utdemir left a comment

Choose a reason for hiding this comment

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

Thank you @roberth, I'm much more happy with this PR in this state, I don't see any harm from exposing isExe.

@roberth
Copy link
Member Author

roberth commented Oct 5, 2020

Thank you for the reviews @utdemir

@roberth roberth merged commit 2d44a36 into NixOS:master Oct 5, 2020
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.

None yet

2 participants