Use flake-parts (#40)

pedorich-n · web-flow · commit 7ad485ca4488 · 2024-02-21T22:25:29.000-05:00
* Use flake-parts

* Add default overlay

* Move nix files to lib; Fix vendor-hash;

* Update readme

* Use legacyPackages in vendor-hash; Use default pkgs in flake;

* Remove allowUnfree = true
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ environments using a [nix-shell] or [devenv](https://devenv.sh).
 
 ## How it works
 
-This flake provides a set of Terraform versions in the form of: 
+This flake provides a set of Terraform versions in the form of:
 
 ```nix
 nixpkgs-terraform.packages.${system}.${version}
@@ -67,7 +67,9 @@ nixConfig = {
 After configuring the inputs from the [Install](#install) section, a common use
 case for this flake could be spawning a [nix-shell] with a specific Terraform
 version, which could be accomplished by extracting the desired version from
-`nixpkgs-terraform.packages` as follows:
+`nixpkgs-terraform.packages` or by using an overlay as follows:
+
+#### As a package
 
 ```nix
 outputs = { self, flake-utils, nixpkgs-terraform, nixpkgs }:
@@ -83,7 +85,25 @@ outputs = { self, flake-utils, nixpkgs-terraform, nixpkgs }:
     });
 ```
 
-Start a new [nix-shell] with Terraform installed by running the following
+#### As an overlay
+
+```nix
+outputs = { self, flake-utils, nixpkgs-terraform, nixpkgs }:
+  flake-utils.lib.eachDefaultSystem (system:
+    let
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [ nixpkgs-terraform.overlays.default ];
+      };
+    in
+    {
+      devShells.default = pkgs.mkShell {
+        buildInputs = [ pkgs.terraform-versions."1.6.3" ];
+      };
+    });
+```
+
+Start a new [nix-shell] with Terraform in scope by running the following
 command:
 
 ```sh
@@ -138,6 +158,7 @@ contributors to follow the commit conventions outlined
 to make it easier for maintainers to release new changes.
 
 ---
+
 <img src="https://www.stackbuilders.com/media/images/Sb-supports.original.png"
 alt="Stack Builders" width="50%"></img>  
 [Check out our libraries](https://github.com/stackbuilders/) | [Join our
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -2,64 +2,45 @@
   description = "A collection of Terraform versions that are automatically updated";
 
   inputs = {
-    flake-utils.inputs.systems.follows = "systems";
-    flake-utils.url = "github:numtide/flake-utils";
-    nixpkgs-unstable.url = "github:nixos/nixpkgs/nixpkgs-unstable";
     nixpkgs.url = "github:nixos/nixpkgs/nixos-23.05";
+    nixpkgs-unstable.url = "github:nixos/nixpkgs/nixpkgs-unstable";
+
     systems.url = "github:nix-systems/default";
+    flake-parts.url = "github:hercules-ci/flake-parts";
   };
 
-  outputs = { self, flake-utils, nixpkgs-unstable, nixpkgs, ... }:
-    flake-utils.lib.eachDefaultSystem
-      (system:
-        let
-          pkgs = nixpkgs.legacyPackages.${system};
-          pkgs-unstable = nixpkgs-unstable.legacyPackages.${system};
-          versions = builtins.fromJSON (builtins.readFile ./versions.json);
-        in
-        {
-          devShells.default = pkgs.mkShell {
-            buildInputs = [
-              pkgs-unstable.black
-              (pkgs-unstable.python3.withPackages
-                (ps: [
-                  ps.pygithub
-                  ps.semver
-                ])
-              )
-              pkgs-unstable.nix-prefetch
-              pkgs.nodejs
-              pkgs.rubyPackages.dotenv
-            ];
-          };
-          # https://github.com/NixOS/nix/issues/7165
-          checks = self.packages.${system};
-          packages = builtins.mapAttrs
-            (version: { hash, vendorHash }: self.lib.buildTerraform {
-              inherit system version hash vendorHash;
-            })
-            versions;
-        }) // {
-      lib.buildTerraform = { system, version, hash, vendorHash }:
-        let
-          pkgs = nixpkgs.legacyPackages.${system};
-          pkgs-unstable = nixpkgs-unstable.legacyPackages.${system};
-        in
-        # https://www.hashicorp.com/blog/hashicorp-adopts-business-source-license
-        if builtins.compareVersions version "1.6.0" >= 0
-        then
-        # https://github.com/NixOS/nixpkgs/blob/nixpkgs-unstable/pkgs/applications/networking/cluster/terraform/default.nix
-          pkgs-unstable.mkTerraform
-            {
-              inherit version hash vendorHash;
-              patches = [ "${nixpkgs-unstable}/pkgs/applications/networking/cluster/terraform/provider-path-0_15.patch" ];
-            }
-        else
-        # https://github.com/NixOS/nixpkgs/blob/nixos-23.05/pkgs/applications/networking/cluster/terraform/default.nix
-          pkgs.mkTerraform {
-            inherit version hash vendorHash;
-            patches = [ "${nixpkgs}/pkgs/applications/networking/cluster/terraform/provider-path-0_15.patch" ];
-          };
+  outputs = { self, flake-parts, ... }@inputs: flake-parts.lib.mkFlake { inherit inputs; } {
+    imports = [
+      inputs.flake-parts.flakeModules.easyOverlay
+    ];
+    systems = import inputs.systems;
+
+    perSystem = { config, pkgs, pkgs-unstable, system, ... }: {
+      _module.args = {
+        pkgs-unstable = inputs.nixpkgs-unstable.legacyPackages.${system};
+      };
+
+      packages = import ./lib/packages.nix { inherit pkgs pkgs-unstable; custom-lib = self.lib; };
+
+      overlayAttrs = {
+        terraform-versions = config.packages;
+      };
+
+      devShells.default = pkgs.mkShell {
+        buildInputs = [
+          pkgs-unstable.black
+          (pkgs-unstable.python3.withPackages (ps: [
+            ps.pygithub
+            ps.semver
+          ]))
+          pkgs-unstable.nix-prefetch
+          pkgs.nodejs
+          pkgs.rubyPackages.dotenv
+        ];
+      };
+    };
+
+    flake = {
       templates = {
         default = {
           description = "Simple nix-shell with Terraform installed via nixpkgs-terraform";
@@ -70,5 +51,8 @@
           path = ./templates/devenv;
         };
       };
+
+      lib = import ./lib;
     };
+  };
 }
diff --git a/lib/build-terraform.nix b/lib/build-terraform.nix
@@ -0,0 +1,15 @@
+{ pkgs, pkgs-unstable, version, hash, vendorHash }:
+# https://www.hashicorp.com/blog/hashicorp-adopts-business-source-license
+if builtins.compareVersions version "1.6.0" >= 0
+then
+# https://github.com/NixOS/nixpkgs/blob/nixpkgs-unstable/pkgs/applications/networking/cluster/terraform/default.nix
+  (pkgs-unstable.mkTerraform {
+    inherit version hash vendorHash;
+    patches = [ ../patches/provider-path-0_15.patch ];
+  })
+else
+# https://github.com/NixOS/nixpkgs/blob/nixos-23.05/pkgs/applications/networking/cluster/terraform/default.nix
+  (pkgs.mkTerraform {
+    inherit version hash vendorHash;
+    patches = [ ../patches/provider-path-0_15.patch ];
+  })
diff --git a/lib/default.nix b/lib/default.nix
@@ -0,0 +1,3 @@
+{
+  buildTerraform = import ./build-terraform.nix;
+}
diff --git a/lib/packages.nix b/lib/packages.nix
@@ -0,0 +1,9 @@
+{ custom-lib, pkgs, pkgs-unstable }:
+let
+  versions = builtins.fromJSON (builtins.readFile ../versions.json);
+in
+builtins.mapAttrs
+  (version: { hash, vendorHash }: custom-lib.buildTerraform {
+    inherit pkgs pkgs-unstable version hash vendorHash;
+  })
+  versions
diff --git a/patches/provider-path-0_15.patch b/patches/provider-path-0_15.patch
@@ -0,0 +1,23 @@
+diff -Naur terraform.old/internal/command/init.go terraform.new/internal/command/init.go
+--- terraform.old/internal/command/init.go
++++ terraform.new/internal/command/init.go
+@@ -3,6 +3,7 @@
+ import (
+ 	"context"
+ 	"fmt"
++	"os"
+ 	"log"
+ 	"strings"
+ 
+@@ -55,6 +56,11 @@
+ 
+ 	var diags tfdiags.Diagnostics
+ 
++	val, ok := os.LookupEnv("NIX_TERRAFORM_PLUGIN_DIR")
++	if ok {
++		flagPluginPath = append(flagPluginPath, val)
++	}
++
+ 	if len(flagPluginPath) > 0 {
+ 		c.pluginPath = flagPluginPath
+ 	}
diff --git a/vendor-hash.nix b/vendor-hash.nix
@@ -1,9 +1,14 @@
 { version, hash }: { sha256 }:
 let
-  terraform = ((builtins.getFlake (toString ./.)).lib.buildTerraform {
-    inherit version hash;
-    system = builtins.currentSystem;
+  flake = builtins.getFlake (toString ./.);
+  system = builtins.currentSystem;
+
+  pkgs = flake.inputs.nixpkgs.legacyPackages.${system};
+  pkgs-unstable = flake.inputs.nixpkgs-unstable.legacyPackages.${system};
+
+  terraform = flake.lib.buildTerraform {
+    inherit pkgs pkgs-unstable version hash;
     vendorHash = sha256;
-  });
+  };
 in
   terraform.goModules or terraform.go-modules

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ buildTerraform = import ./build-terraform.nix;`
	`3`	`+}`