Merge pull request #120: cli: Add lockfile mode

Author: piegamesde

README.md

@@ -116,10 +116,11 @@ Commands:
   help          Print this message or the help of the given subcommand(s)
 
 Options:
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-  -v, --verbose             Print debug messages
-  -h, --help                Print help
-  -V, --version             Print version
+  -d, --directory <FOLDER>     Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
+      --lock-file <LOCK_FILE>  Specifies the path to the sources.json and activates lockfile mode. In lockfile mode, no default.nix will be generated and --directory will be ignored
+  -v, --verbose                Print debug messages
+  -h, --help                   Print help
+  -V, --version                Print version
 ```
 
 ### Initialization
@@ -139,10 +140,9 @@ Intializes the npins directory. Running this multiple times will restore/upgrade
 Usage: npins init [OPTIONS]
 
 Options:
-      --bare                Don't add an initial `nixpkgs` entry
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-  -v, --verbose             Print debug messages
-  -h, --help                Print help
+      --bare     Don't add an initial `nixpkgs` entry
+  -v, --verbose  Print debug messages
+  -h, --help     Print help
 ```
 
 ### Migrate from Niv
@@ -168,10 +168,9 @@ Arguments:
   [PATH]  [default: nix/sources.json]
 
 Options:
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-  -n, --name <NAME>         Only import one entry from Niv
-  -v, --verbose             Print debug messages
-  -h, --help                Print help
+  -n, --name <NAME>  Only import one entry from Niv
+  -v, --verbose      Print debug messages
+  -h, --help         Print help
 ```
 
 ### Adding dependencies
@@ -211,12 +210,11 @@ Commands:
   help     Print this message or the help of the given subcommand(s)
 
 Options:
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-      --name <NAME>         Add the pin with a custom name. If a pin with that name already exists, it will be overwritten
-      --frozen              Add the pin as frozen, meaning that it will be ignored by `npins update` by default
-  -v, --verbose             Print debug messages
-  -n, --dry-run             Don't actually apply the changes
-  -h, --help                Print help
+      --name <NAME>  Add the pin with a custom name. If a pin with that name already exists, it will be overwritten
+      --frozen       Add the pin as frozen, meaning that it will be ignored by `npins update` by default
+  -n, --dry-run      Don't actually apply the changes
+  -v, --verbose      Print debug messages
+  -h, --help         Print help
 ```
 
 There are several options for tracking git branches, releases and tags:
@@ -233,18 +231,16 @@ Arguments:
 Options:
   -b, --branch <BRANCH>
           Track a branch instead of a release
-  -d, --directory <FOLDER>
-          Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
       --name <NAME>
           Add the pin with a custom name. If a pin with that name already exists, it will be overwritten
       --at <tag or rev>
           Use a specific commit/release instead of the latest. This may be a tag name, or a git revision when --branch is set
       --frozen
           Add the pin as frozen, meaning that it will be ignored by `npins update` by default
-  -v, --verbose
-          Print debug messages
       --pre-releases
           Also track pre-releases. Conflicts with the --branch option
+  -v, --verbose
+          Print debug messages
       --upper-bound <version>
           Bound the version resolution. For example, setting this to "2" will restrict updates to 1.X versions. Conflicts with the --branch option
       --release-prefix <RELEASE_PREFIX>
@@ -267,9 +263,8 @@ Arguments:
   <NAME>  
 
 Options:
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-  -v, --verbose             Print debug messages
-  -h, --help                Print help
+  -v, --verbose  Print debug messages
+  -h, --help     Print help
 ```
 
 ### Show current entries
@@ -283,9 +278,8 @@ Lists the current pin entries
 Usage: npins show [OPTIONS]
 
 Options:
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-  -v, --verbose             Print debug messages
-  -h, --help                Print help
+  -v, --verbose  Print debug messages
+  -h, --help     Print help
 ```
 
 ### Updating dependencies
@@ -302,16 +296,14 @@ Arguments:
   [NAMES]...  Updates only the specified pins
 
 Options:
-  -d, --directory <FOLDER>
-          Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
   -p, --partial
           Don't update versions, only re-fetch hashes
   -f, --full
           Re-fetch hashes even if the version hasn't changed. Useful to make sure the derivations are in the Nix store
-  -v, --verbose
-          Print debug messages
   -n, --dry-run
           Print the diff, but don't write back the changes
+  -v, --verbose
+          Print debug messages
       --frozen
           Allow updating frozen pins, which would otherwise be ignored
       --max-concurrent-downloads <MAX_CONCURRENT_DOWNLOADS>
@@ -331,9 +323,8 @@ Upgrade the sources.json and default.nix to the latest format version. This may
 Usage: npins upgrade [OPTIONS]
 
 Options:
-  -d, --directory <FOLDER>  Base folder for sources.json and the boilerplate default.nix [env: NPINS_DIRECTORY=] [default: npins]
-  -v, --verbose             Print debug messages
-  -h, --help                Print help
+  -v, --verbose  Print debug messages
+  -h, --help     Print help
 ```
 
 ### Using private GitLab repositories

src/cli.rs

@@ -575,14 +575,18 @@ fn print_diff(name: &str, diff: impl AsRef<[diff::DiffEntry]>) {
 pub struct Opts {
     /// Base folder for sources.json and the boilerplate default.nix
     #[arg(
-        global = true,
         short = 'd',
         long = "directory",
         default_value = "npins",
         env = "NPINS_DIRECTORY"
     )]
     folder: std::path::PathBuf,
 
+    /// Specifies the path to the sources.json and activates lockfile mode.
+    /// In lockfile mode, no default.nix will be generated and --directory will be ignored.
+    #[arg(long)]
+    lock_file: Option<std::path::PathBuf>,
+
     /// Print debug messages.
     #[arg(global = true, short = 'v', long = "verbose")]
     pub verbose: bool,
@@ -593,7 +597,11 @@ pub struct Opts {
 
 impl Opts {
     fn read_pins(&self) -> Result<NixPins> {
-        let path = self.folder.join("sources.json");
+        let path = if let Some(lock_file) = self.lock_file.as_ref() {
+            lock_file.to_owned()
+        } else {
+            self.folder.join("sources.json")
+        };
         let fh = std::io::BufReader::new(std::fs::File::open(&path).with_context(move || {
             format!(
                 "Failed to open {}. You must initialize npins before you can show current pins.",
@@ -605,10 +613,14 @@ impl Opts {
     }
 
     fn write_pins(&self, pins: &NixPins) -> Result<()> {
-        if !self.folder.exists() {
-            std::fs::create_dir(&self.folder)?;
-        }
-        let path = self.folder.join("sources.json");
+        let path = if let Some(lock_file) = &self.lock_file {
+            lock_file.to_owned()
+        } else {
+            if !self.folder.exists() {
+                std::fs::create_dir(&self.folder)?;
+            }
+            self.folder.join("sources.json")
+        };
         let mut fh = std::fs::File::create(&path)
             .with_context(move || format!("Failed to open {} for writing.", path.display()))?;
         serde_json::to_writer_pretty(&mut fh, &versions::to_value_versioned(pins))?;
@@ -618,23 +630,27 @@ impl Opts {
 
     async fn init(&self, o: &InitOpts) -> Result<()> {
         log::info!("Welcome to npins!");
-        let default_nix = DEFAULT_NIX;
-        if !self.folder.exists() {
-            log::info!("Creating `{}` directory", self.folder.display());
-            std::fs::create_dir(&self.folder).context("Failed to create npins folder")?;
-        }
-        log::info!("Writing default.nix");
-        let p = self.folder.join("default.nix");
-        let mut fh = std::fs::File::create(&p).context("Failed to create npins default.nix")?;
-        fh.write_all(default_nix.as_bytes())?;
 
-        // Only create the pins if the file isn't there yet
-        if self.folder.join("sources.json").exists() {
-            log::info!(
-                "The file '{}' already exists; nothing to do.",
-                self.folder.join("pins.json").display()
-            );
-            return Ok(());
+        // Skip the entire default.nix and convenience creating folders bit in lockfile mode
+        if self.lock_file.is_none() {
+            let default_nix = DEFAULT_NIX;
+            if !self.folder.exists() {
+                log::info!("Creating `{}` directory", self.folder.display());
+                std::fs::create_dir(&self.folder).context("Failed to create npins folder")?;
+            }
+            log::info!("Writing default.nix");
+            let p = self.folder.join("default.nix");
+            let mut fh = std::fs::File::create(&p).context("Failed to create npins default.nix")?;
+            fh.write_all(default_nix.as_bytes())?;
+
+            // Only create the pins if the file isn't there yet
+            if self.folder.join("sources.json").exists() {
+                log::info!(
+                    "The file '{}' already exists; nothing to do.",
+                    self.folder.join("pins.json").display()
+                );
+                return Ok(());
+            }
         }
 
         let initial_pins = if o.bare {
@@ -651,7 +667,7 @@ impl Opts {
         self.write_pins(&initial_pins)?;
         log::info!(
             "Successfully written initial files to '{}'.",
-            self.folder.display()
+            self.lock_file.as_ref().unwrap_or(&self.folder).display()
         );
         Ok(())
     }
@@ -812,19 +828,22 @@ impl Opts {
     }
 
     fn upgrade(&self) -> Result<()> {
-        anyhow::ensure!(
-            self.folder.exists(),
-            "Could not find npins folder at {}",
-            self.folder.display(),
-        );
+        if self.lock_file.is_none() {
+            anyhow::ensure!(
+                self.folder.exists(),
+                "Could not find npins folder at {}",
+                self.folder.display(),
+            );
 
-        let nix_path = self.folder.join("default.nix");
-        let nix_file = DEFAULT_NIX;
-        if std::fs::read_to_string(&nix_path)? == nix_file {
-            log::info!("default.nix is already up to date");
-        } else {
-            log::info!("Replacing default.nix with an up to date version");
-            std::fs::write(&nix_path, nix_file).context("Failed to create npins default.nix")?;
+            let nix_path = self.folder.join("default.nix");
+            let nix_file = DEFAULT_NIX;
+            if std::fs::read_to_string(&nix_path)? == nix_file {
+                log::info!("default.nix is already up to date");
+            } else {
+                log::info!("Replacing default.nix with an up to date version");
+                std::fs::write(&nix_path, nix_file)
+                    .context("Failed to create npins default.nix")?;
+            }
         }
 
         log::info!("Upgrading sources.json to the newest format version");
@@ -842,7 +861,9 @@ impl Opts {
         let pins_raw_new = versions::upgrade(pins_raw.clone()).context("Upgrading failed")?;
         let pins: NixPins = serde_json::from_value(pins_raw_new.clone())?;
         if pins_raw_new != serde_json::Value::Object(pins_raw) {
-            log::info!("Done. It is recommended to at least run `update --partial` afterwards.");
+            log::info!(
+                "Done. It is recommended to at least run `npins update --partial` afterwards."
+            );
         }
         self.write_pins(&pins)
     }
@@ -1057,6 +1078,9 @@ impl Opts {
     }
 
     pub async fn run(&self) -> Result<()> {
+        if self.lock_file.is_some() && &*self.folder != std::path::Path::new("npins") {
+            anyhow::bail!("If --lock-file is set, --directory will be ignored and thus should not be set to a non-default value (which is \"npins\")");
+        }
         match &self.command {
             Command::Init(o) => self.init(o).await?,
             Command::Show => self.show()?,

test.nix

@@ -340,6 +340,38 @@ let
       '';
 in
 {
+  initNoDefaultNix = mkGitTest {
+    name = "init-no-default-nix";
+    repositories."foo" = gitRepo;
+    commands = ''
+      npins --lock-file sources.json init --bare
+      # Setting a custom directory should fail in lockfile mode
+      ! npins --lock-file sources.json -d npins2 show
+      npins --lock-file sources.json -d npins show
+      test -e npins/default.nix && exit 1
+      V=$(jq -r .pins sources.json)
+      [[ "$V" = "{}" ]]
+    '';
+  };
+
+  addInLockfileMode = mkGitTest rec {
+    name = "add-in-lockfile-mode";
+    repositories."foo" = gitRepo;
+    commands = ''
+      npins --lock-file sources2.json init --bare
+      npins --lock-file sources2.json add git http://localhost:8000/foo -b test-branch
+
+      # Check version and url
+      eq "$(jq -r .pins.foo.version sources2.json)" "null"
+      eq "$(jq -r .pins.foo.revision sources2.json)" "$(resolveGitCommit ${repositories."foo"} HEAD)"
+      eq "$(jq -r .pins.foo.url sources2.json)" "null"
+
+      # Check setting the directory in normal mode still works
+      npins -d testing init --bare
+      NPINS_DIRECTORY=testing npins show
+    '';
+  };
+
   addDryRun = mkGitTest {
     name = "add-dry-run";
     repositories."foo" = gitRepo;