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

remotes: add gpg-import option. #91

Merged
merged 2 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,5 @@ jobs:
- run: nix flake check
- name: Run Nix tests
run: |
cd tests/
result=$(nix eval --impure --expr 'import ./ref-test.nix {}')
if [ "$result" != "[ ]" ]; then
echo "Test failed: Expected [], but got $result"
exit 1
fi
./test.sh
shell: bash
25 changes: 4 additions & 21 deletions modules/installer.nix
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

let
utils = import ./ref.nix { inherit lib; };
remotes = import ./remotes.nix { inherit pkgs; };

flatpakrefCache = builtins.foldl'
(acc: package:
Expand Down Expand Up @@ -168,30 +169,12 @@ let
in
installCmd + "\n" + pinCommitOrUpdate;

flatpakAddRemotesCmd = installation: { name, location, args ? null, ... }: ''
${pkgs.flatpak}/bin/flatpak remote-add --${installation} --if-not-exists ${if args == null then "" else args} ${name} ${location}
'';
flatpakAddRemote = installation: remotes: map (flatpakAddRemotesCmd installation) remotes;

flatpakDeleteRemotesCmd = installation: uninstallUnmanaged: {}: ''
# Delete all remotes that are present in the old state but not the new one
# $OLD_STATE and $NEW_STATE are globals, declared in the output of pkgs.writeShellScript.
# If uninstallUnmanagedState is true, then the remotes will be deleted forcefully.
${pkgs.jq}/bin/jq -r -n \
--argjson old "$OLD_STATE" \
--argjson new "$NEW_STATE" \
'(($old.remotes // []) - ($new.remotes // []))[]' \
| while read -r REMOTE_NAME; do
${pkgs.flatpak}/bin/flatpak remote-delete ${if uninstallUnmanaged then " --force " else " " } --${installation} $REMOTE_NAME

done
'';


flatpakInstall = installation: update: packages: map (flatpakInstallCmd installation update) packages;

mkFlatpakInstallCmd = installation: update: packages: builtins.foldl' (x: y: x + y) '''' (flatpakInstall installation update packages);
mkFlatpakAddRemotesCmd = installation: remotes: builtins.foldl' (x: y: x + y) '''' (flatpakAddRemote installation remotes);

flatpakDeleteRemotesCmd = remotes.flatpakDeleteRemotesCmd;
mkFlatpakAddRemotesCmd = remotes.mkFlatpakAddRemotesCmd;
in
pkgs.writeShellScript "flatpak-managed-install" ''
# This script is triggered at build time by a transient systemd unit.
Expand Down
5 changes: 5 additions & 0 deletions modules/options.nix
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ let
description = lib.mdDoc "The remote location. Must be a valid URL of a flatpak repo.";
default = "https://dl.flathub.org/repo/flathub.flatpakrepo";
};
gpg-import = mkOption {
type = types.nullOr types.str;
description = "Import GPG key from FILE";
default = null;
};
args = mkOption {
type = types.nullOr types.str;
description = "Extra arguments to pass to flatpak remote-add.";
Expand Down
33 changes: 33 additions & 0 deletions modules/remotes.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{ pkgs }:

let
flatpakAddRemotesCmd = installation: { name, location, gpg-import ? null, args ? null, ... }:
let
gpg-import-flag = ''${if gpg-import == null then "" else "--gpg-import=${gpg-import}" }'';
args-flag = ''${if args == null then "" else args}'';
in
''
${pkgs.flatpak}/bin/flatpak remote-add --${installation} --if-not-exists ${args-flag} ${gpg-import-flag} ${name} ${location}
'';

flatpakAddRemote = installation: remotes: map (flatpakAddRemotesCmd installation) remotes;

flatpakDeleteRemotesCmd = installation: uninstallUnmanaged: {}: ''
# Delete all remotes that are present in the old state but not the new one
# $OLD_STATE and $NEW_STATE are globals, declared in the output of pkgs.writeShellScript.
# If uninstallUnmanagedState is true, then the remotes will be deleted forcefully.
${pkgs.jq}/bin/jq -r -n \
--argjson old "$OLD_STATE" \
--argjson new "$NEW_STATE" \
'(($old.remotes // []) - ($new.remotes // []))[]' \
| while read -r REMOTE_NAME; do
${pkgs.flatpak}/bin/flatpak remote-delete ${if uninstallUnmanaged then " --force " else " " } --${installation} $REMOTE_NAME

done
'';

mkFlatpakAddRemotesCmd = installation: remotes: builtins.foldl' (x: y: x + y) '''' (flatpakAddRemote installation remotes);
in
{
inherit mkFlatpakAddRemotesCmd flatpakDeleteRemotesCmd;
}
15 changes: 15 additions & 0 deletions test.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
cd tests/

test_count=0
for test_file in *-test.nix; do
echo "Collecting results for... ${test_file}"
result=$(nix eval --show-trace --impure --expr "import ./${test_file} {}")

if [ "$result" != "[ ]" ]; then
echo "Test failed: Expected [], but got $result in $test_file"
exit 1
fi
((test_count++))
done

echo "All tests in ${test_count} suites passed."
19 changes: 19 additions & 0 deletions tests/remotes-test.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{ pkgs ? import <nixpkgs> { } }:

let
inherit (pkgs) lib;
inherit (lib) runTests;
installation = "system";
installer = import ../modules/remotes.nix { inherit pkgs; };
in
runTests {
testMkFlatpakAddRemotesCmd = {
expr = installer.mkFlatpakAddRemotesCmd installation [{ name = "flathub"; location = "http://flathub"; }];
expected = "${pkgs.flatpak}/bin/flatpak remote-add --system --if-not-exists flathub http://flathub\n";
};

testMkFlatpakAddRemotesCmdCmdWithTrustedKeys = {
expr = installer.mkFlatpakAddRemotesCmd installation [{ name = "flathub"; location = "http://flathub"; gpg-import = "trustedkeys.gpg"; }];
expected = "${pkgs.flatpak}/bin/flatpak remote-add --system --if-not-exists --gpg-import=trustedkeys.gpg flathub http://flathub\n";
};
}
Loading