nix-diff: Explain why two Nix derivations differ

[ bsd3, library, program, system ] [ Propose Tags ]

This package provides a nix-diff executable which explains why two Nix derivations (i.e. *.drv files) differ


[Skip to Readme]

Modules

  • Nix
    • Nix.Diff
      • Render
        • Nix.Diff.Render.HumanReadable
      • Nix.Diff.Transformations
      • Nix.Diff.Types

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.0.10, 1.0.11, 1.0.12, 1.0.13, 1.0.14, 1.0.15, 1.0.16, 1.0.17, 1.0.18, 1.0.19 (info)
Change log CHANGELOG.md
Dependencies aeson, attoparsec (>=0.13 && <0.15), base (>=4.9 && <5), bytestring (>=0.9 && <0.12), containers (>=0.5 && <0.7), directory (<1.4), filepath (<1.5), generic-arbitrary (<1.1), mtl (>=2.2 && <2.3), nix-derivation (>=1.1 && <1.2), nix-diff, optparse-applicative (>=0.14.0.0 && <0.18), patience (>=0.3 && <0.4), process (<1.7), QuickCheck (<2.15), quickcheck-instances (<3.29), text (>=1.2 && <1.3), uniplate (<1.17), unix (<2.8), vector (>=0.12 && <0.13) [details]
License BSD-3-Clause
Copyright 2017 Gabriella Gonzalez
Author Gabriella Gonzalez
Maintainer GenuineGabriella@gmail.com
Revised Revision 1 made by GabrielGonzalez at 2023-01-14T23:37:00Z
Category System
Home page https://github.com/Gabriella439/nix-diff
Uploaded by GabrielGonzalez at 2023-01-04T04:15:34Z
Distributions NixOS:1.0.19
Reverse Dependencies 1 direct, 0 indirect [details]
Executables nix-diff
Downloads 6916 total (29 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2023-01-04 [all 2 reports]

Readme for nix-diff-1.0.19

[back to package description]

nix-diff

This package provides a nix-diff executable which explains why two Nix derivations differ. The most common use cases for this are:

  • Understanding why you have a cache miss
  • Verifying a Nix change had the intended effect at the derivation level
  • Improving your understanding of how Nix works

For example, consider the following Nix derivation to build a bare-bones NixOS system:

let
  nixos = import <nixpkgs/nixos> {
    system = "x86_64-linux";

    configuration = {
      boot.loader.grub.devices = [ "/dev/sda" ];

      fileSystems."/" = {
        device = "/dev/sda";
      };
    };
  };

in
  nixos.system

We can use nix-instantiate to compute the derivation for the above file:

$ nix-instantiate example.nix  # Your exact hash might differ
warning: you did not specify ‘--add-root’; the result might be removed by the garbage collector
/nix/store/6z9nr5pzs4j1v9mld517dmlcz61zy78z-nixos-system-nixos-18.03pre119245.5cfd049a03.drv

Now, let's add a service to our system definition:

let
  nixos = import <nixpkgs/nixos> {
    system = "x86_64-linux";

    configuration = {
      boot.loader.grub.devices = [ "/dev/sda" ];

      fileSystems."/" = {
        device = "/dev/sda";
      };

      services.apache-kafka.enable = true;
    };
  };

in
  nixos.system

... and compute the derivation for the updated system:

$ nix-instantiate example.nix
warning: you did not specify ‘--add-root’; the result might be removed by the garbage collector
/nix/store/k05ibijg0kknvwrgfyb7dxwjrs8qrlbj-nixos-system-nixos-18.03pre119245.5cfd049a03.drv

We can use nix-diff to compare the two computed derivations to determine what changed about our system:

$ nix-diff /nix/store/6z9nr5pzs4j1v9mld517dmlcz61zy78z-nixos-system-nixos-18.03pre119245.5cfd049a03.drv /nix/store/k05ibijg0kknvwrgfyb7dxwjrs8qrlbj-nixos-system-nixos-18.03pre119245.5cfd049a03.drv

... which produces the following output:

It's also possible to pass store paths or links to store paths, for example:

$ nix-build example.nix
$ nix-diff /run/current-system ./result

Testing

Run tests, using cabal test command.

You need to have nix installed in your PC.

Development status

Build Status

I don't currently plan to add any new features, but I do welcome feature requests. Just open an issue on the issue tracker if you would like to request an improvement.

License (BSD 3-clause)

Copyright (c) 2017 Gabriella Gonzalez
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of Gabriella Gonzalez nor the names of other contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.