Miscellaneous cleanup

2026-01-12 07:50:53 -05:00 · 2024-05-29 17:47:31 -07:00
parent d13b7b0d6d
commit 301c64fa2f
46 changed files with 1512 additions and 1441 deletions
--- a/fixtures/projects/basic/basic-java-project/kotlin/settings.gradle.kts
+++ b/fixtures/projects/basic/basic-java-project/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/basic/basic-kotlin-project/kotlin/settings.gradle.kts
+++ b/fixtures/projects/basic/basic-kotlin-project/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/buildsrc/plugin-in-buildsrc/kotlin/buildSrc/settings.gradle.kts
+++ b/fixtures/projects/buildsrc/plugin-in-buildsrc/kotlin/buildSrc/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/buildsrc/plugin-in-buildsrc/kotlin/settings.gradle.kts
+++ b/fixtures/projects/buildsrc/plugin-in-buildsrc/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/dependency/classifier/kotlin/settings.gradle.kts
+++ b/fixtures/projects/dependency/classifier/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/dependency/maven-bom/kotlin/settings.gradle.kts
+++ b/fixtures/projects/dependency/maven-bom/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/dependency/snapshot-dynamic/kotlin/settings.gradle.kts
+++ b/fixtures/projects/dependency/snapshot-dynamic/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/dependency/snapshot/kotlin/settings.gradle.kts
+++ b/fixtures/projects/dependency/snapshot/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/integration/settings-buildscript/groovy/default.nix
+++ b/fixtures/projects/integration/settings-buildscript/groovy/default.nix
@@ -1,9 +1,9 @@
-with (import <nixpkgs> {});
+with (import <nixpkgs> { });
 let
-  buildGradle = callPackage ./gradle-env.nix {};
+  buildGradle = callPackage ./gradle-env.nix { };
 in
-  buildGradle {
-    envSpec = ./gradle-env.json;
-    src = ./.;
-    gradleFlags = [ "tasks" ];
-  }
+buildGradle {
+  envSpec = ./gradle-env.json;
+  src = ./.;
+  gradleFlags = [ "tasks" ];
+}
--- a/fixtures/projects/integration/settings-buildscript/groovy/gradle-env.nix
+++ b/fixtures/projects/integration/settings-buildscript/groovy/gradle-env.nix
@@ -19,126 +19,167 @@
 #         '';
 #       }

-{ stdenv, buildEnv, fetchurl, gradleGen, writeText, writeTextDir }:
+{
+  stdenv,
+  buildEnv,
+  fetchurl,
+  gradleGen,
+  writeText,
+  writeTextDir,
+}:

-{ envSpec
-, pname ? null
-, version ? null
-, enableParallelBuilding ? true
-, gradleFlags ? [ "build" ]
-, gradlePackage ? null
-, enableDebug ? false
-, ... } @ args:
+{
+  envSpec,
+  pname ? null,
+  version ? null,
+  enableParallelBuilding ? true,
+  gradleFlags ? [ "build" ],
+  gradlePackage ? null,
+  enableDebug ? false,
+  ...
+}@args:

 let
  inherit (builtins)
-    attrValues concatStringsSep filter fromJSON match replaceStrings sort;
+    attrValues
+    concatStringsSep
+    filter
+    fromJSON
+    match
+    replaceStrings
+    sort
+    ;

  inherit (stdenv.lib)
-    assertMsg concatMapStringsSep groupBy' hasSuffix last mapAttrs
-    mapAttrsToList optionalString readFile removeSuffix unique versionAtLeast
-    versionOlder;
+    assertMsg
+    concatMapStringsSep
+    groupBy'
+    hasSuffix
+    last
+    mapAttrs
+    mapAttrsToList
+    optionalString
+    readFile
+    removeSuffix
+    unique
+    versionAtLeast
+    versionOlder
+    ;

-  mkDep = depSpec: stdenv.mkDerivation {
-    inherit (depSpec) name;
+  mkDep =
+    depSpec:
+    stdenv.mkDerivation {
+      inherit (depSpec) name;

-    src = fetchurl {
-      inherit (depSpec) urls sha256;
+      src = fetchurl { inherit (depSpec) urls sha256; };
+
+      phases = "installPhase";
+
+      installPhase = ''
+        mkdir -p $out/${depSpec.path}
+        ln -s $src $out/${depSpec.path}/${depSpec.name}
+      '';
    };

-    phases = "installPhase";
-
-    installPhase = ''
-      mkdir -p $out/${depSpec.path}
-      ln -s $src $out/${depSpec.path}/${depSpec.name}
-    '';
-  };
-
-  mkModuleMetadata = deps:
+  mkModuleMetadata =
+    deps:
    let
-      ids = filter
-        (id: id.type == "pom")
-        (map (dep: dep.id) deps);
+      ids = filter (id: id.type == "pom") (map (dep: dep.id) deps);

-      modules = groupBy'
-        (meta: id:
-          let
-            isNewer = versionOlder meta.latest id.version;
-            isNewerRelease =
-              !(hasSuffix "-SNAPSHOT" id.version) &&
-              versionOlder meta.release id.version;
-          in {
-            groupId = id.group;
-            artifactId = id.name;
-            latest = if isNewer then id.version else meta.latest;
-            release = if isNewerRelease then id.version else meta.release;
-            versions = meta.versions ++ [id.version];
+      modules =
+        groupBy'
+          (
+            meta: id:
+            let
+              isNewer = versionOlder meta.latest id.version;
+              isNewerRelease = !(hasSuffix "-SNAPSHOT" id.version) && versionOlder meta.release id.version;
+            in
+            {
+              groupId = id.group;
+              artifactId = id.name;
+              latest = if isNewer then id.version else meta.latest;
+              release = if isNewerRelease then id.version else meta.release;
+              versions = meta.versions ++ [ id.version ];
+            }
+          )
+          {
+            latest = "";
+            release = "";
+            versions = [ ];
          }
-        )
-        {
-          latest = "";
-          release = "";
-          versions = [];
-        }
-        (id: "${replaceStrings ["."] ["/"] id.group}/${id.name}/maven-metadata.xml")
-        ids;
-
+          (id: "${replaceStrings [ "." ] [ "/" ] id.group}/${id.name}/maven-metadata.xml")
+          ids;
    in
-      attrValues (mapAttrs (path: meta:
+    attrValues (
+      mapAttrs (
+        path: meta:
        let
          versions' = sort versionOlder (unique meta.versions);
        in
-          with meta; writeTextDir path ''
-            <?xml version="1.0" encoding="UTF-8"?>
-            <metadata modelVersion="1.1">
-              <groupId>${groupId}</groupId>
-              <artifactId>${artifactId}</artifactId>
-              <versioning>
-                ${optionalString (latest != "") "<latest>${latest}</latest>"}
-                ${optionalString (release != "") "<release>${release}</release>"}
-                <versions>
-                  ${concatMapStringsSep "\n    " (v: "<version>${v}</version>") versions'}
-                </versions>
-              </versioning>
-            </metadata>
-          ''
-      ) modules);
+        with meta;
+        writeTextDir path ''
+          <?xml version="1.0" encoding="UTF-8"?>
+          <metadata modelVersion="1.1">
+            <groupId>${groupId}</groupId>
+            <artifactId>${artifactId}</artifactId>
+            <versioning>
+              ${optionalString (latest != "") "<latest>${latest}</latest>"}
+              ${optionalString (release != "") "<release>${release}</release>"}
+              <versions>
+                ${concatMapStringsSep "\n    " (v: "<version>${v}</version>") versions'}
+              </versions>
+            </versioning>
+          </metadata>
+        ''
+      ) modules
+    );

-  mkSnapshotMetadata = deps:
+  mkSnapshotMetadata =
+    deps:
    let
      snapshotDeps = filter (dep: dep ? build && dep ? timestamp) deps;

-      modules = groupBy'
-        (meta: dep:
-          let
-            id = dep.id;
-            isNewer = dep.build > meta.buildNumber;
-            # Timestamp values can be bogus, e.g. jitpack.io
-            updated = if (match "[0-9]{8}\.[0-9]{6}" dep.timestamp) != null
-                      then replaceStrings ["."] [""] dep.timestamp
-                      else "";
-          in {
-            groupId = id.group;
-            artifactId = id.name;
-            version = id.version;
-            timestamp = if isNewer then dep.timestamp else meta.timestamp;
-            buildNumber = if isNewer then dep.build else meta.buildNumber;
-            lastUpdated = if isNewer then updated else meta.lastUpdated;
-            versions = meta.versions or [] ++ [{
-              classifier = id.classifier or "";
-              extension = id.extension;
-              value = "${removeSuffix "-SNAPSHOT" id.version}-${dep.timestamp}-${toString dep.build}";
-              updated = updated;
-            }];
+      modules =
+        groupBy'
+          (
+            meta: dep:
+            let
+              id = dep.id;
+              isNewer = dep.build > meta.buildNumber;
+              # Timestamp values can be bogus, e.g. jitpack.io
+              updated =
+                if (match "[0-9]{8}\.[0-9]{6}" dep.timestamp) != null then
+                  replaceStrings [ "." ] [ "" ] dep.timestamp
+                else
+                  "";
+            in
+            {
+              groupId = id.group;
+              artifactId = id.name;
+              version = id.version;
+              timestamp = if isNewer then dep.timestamp else meta.timestamp;
+              buildNumber = if isNewer then dep.build else meta.buildNumber;
+              lastUpdated = if isNewer then updated else meta.lastUpdated;
+              versions = meta.versions or [ ] ++ [
+                {
+                  classifier = id.classifier or "";
+                  extension = id.extension;
+                  value = "${removeSuffix "-SNAPSHOT" id.version}-${dep.timestamp}-${toString dep.build}";
+                  updated = updated;
+                }
+              ];
+            }
+          )
+          {
+            timestamp = "";
+            buildNumber = -1;
+            lastUpdated = "";
          }
-        )
-        {
-          timestamp = "";
-          buildNumber = -1;
-          lastUpdated = "";
-        }
-        (dep: "${replaceStrings ["."] ["/"] dep.id.group}/${dep.id.name}/${dep.id.version}/maven-metadata.xml")
-        snapshotDeps;
+          (
+            dep:
+            "${replaceStrings [ "." ] [ "/" ] dep.id.group}/${dep.id.name}/${dep.id.version}/maven-metadata.xml"
+          )
+          snapshotDeps;

      mkSnapshotVersion = version: ''
        <snapshotVersion>
@@ -148,10 +189,12 @@ let
          ${optionalString (version.updated != "") "<updated>${version.updated}</updated>"}
        </snapshotVersion>
      '';
-
    in
-      attrValues (mapAttrs (path: meta:
-        with meta; writeTextDir path ''
+    attrValues (
+      mapAttrs (
+        path: meta:
+        with meta;
+        writeTextDir path ''
          <?xml version="1.0" encoding="UTF-8"?>
          <metadata modelVersion="1.1">
            <groupId>${groupId}</groupId>
@@ -169,92 +212,98 @@ let
            </versioning>
          </metadata>
        ''
-      ) modules);
+      ) modules
+    );

-  mkRepo = project: type: deps: buildEnv {
-    name = "${project}-gradle-${type}-env";
-    paths = map mkDep deps ++ mkModuleMetadata deps ++ mkSnapshotMetadata deps;
-  };
+  mkRepo =
+    project: type: deps:
+    buildEnv {
+      name = "${project}-gradle-${type}-env";
+      paths = map mkDep deps ++ mkModuleMetadata deps ++ mkSnapshotMetadata deps;
+    };

-  mkInitScript = projectSpec: gradle:
+  mkInitScript =
+    projectSpec: gradle:
    let
      repos = mapAttrs (mkRepo projectSpec.name) projectSpec.dependencies;
-      hasDependencies = mapAttrs (type: deps: deps != []) projectSpec.dependencies;
+      hasDependencies = mapAttrs (type: deps: deps != [ ]) projectSpec.dependencies;
    in
-      assert (assertMsg (hasDependencies.settings -> versionAtLeast gradle.version "6.0") ''
+    assert (
+      assertMsg (hasDependencies.settings -> versionAtLeast gradle.version "6.0") ''
        Project `${projectSpec.name}' has settings script dependencies, such as settings
        plugins, which are not supported by gradle2nix for Gradle versions prior to 6.0.

        Potential remedies:
        - Pass `--gradle-version=<version>' to the gradle2nix command.
        - Patch the `settings.gradle[.kts]' file to remove script dependencies.
-      '');
+      ''
+    );

-      writeText "init.gradle" ''
-        static def offlineRepo(RepositoryHandler repositories, String env, String path) {
-            repositories.clear()
-            repositories.maven {
-                name "Nix''${env.capitalize()}MavenOffline"
-                url path
-                metadataSources {
-                    it.gradleMetadata()
-                    it.mavenPom()
-                    it.artifact()
-                }
-            }
-            repositories.ivy {
-                name "Nix''${env.capitalize()}IvyOffline"
-                url path
-                layout "maven"
-                metadataSources {
-                    it.gradleMetadata()
-                    it.ivyDescriptor()
-                    it.artifact()
+    writeText "init.gradle" ''
+      static def offlineRepo(RepositoryHandler repositories, String env, String path) {
+          repositories.clear()
+          repositories.maven {
+              name "Nix''${env.capitalize()}MavenOffline"
+              url path
+              metadataSources {
+                  it.gradleMetadata()
+                  it.mavenPom()
+                  it.artifact()
+              }
+          }
+          repositories.ivy {
+              name "Nix''${env.capitalize()}IvyOffline"
+              url path
+              layout "maven"
+              metadataSources {
+                  it.gradleMetadata()
+                  it.ivyDescriptor()
+                  it.artifact()
+              }
+          }
+      }
+
+      ${optionalString (hasDependencies.settings && (versionAtLeast gradle.version "6.0")) ''
+        gradle.beforeSettings {
+            offlineRepo(it.buildscript.repositories, "settings", "${repos.settings}")
+        }
+      ''}
+
+      ${optionalString (hasDependencies.plugin) ''
+        gradle.settingsEvaluated {
+            offlineRepo(it.pluginManagement.repositories, "plugin", "${repos.plugin}")
+        }
+      ''}
+
+      ${optionalString (hasDependencies.buildscript) ''
+        gradle.projectsLoaded {
+            allprojects {
+                buildscript {
+                    offlineRepo(repositories, "buildscript", "${repos.buildscript}")
                }
            }
        }
+      ''}

-        ${optionalString (hasDependencies.settings && (versionAtLeast gradle.version "6.0")) ''
-          gradle.beforeSettings {
-              offlineRepo(it.buildscript.repositories, "settings", "${repos.settings}")
-          }
-        ''}
+      ${optionalString (hasDependencies.project) ''
+        gradle.projectsLoaded {
+            allprojects {
+                offlineRepo(repositories, "project", "${repos.project}")
+            }
+        }
+      ''}
+    '';

-        ${optionalString (hasDependencies.plugin) ''
-          gradle.settingsEvaluated {
-              offlineRepo(it.pluginManagement.repositories, "plugin", "${repos.plugin}")
-          }
-        ''}
-
-        ${optionalString (hasDependencies.buildscript) ''
-          gradle.projectsLoaded {
-              allprojects {
-                  buildscript {
-                      offlineRepo(repositories, "buildscript", "${repos.buildscript}")
-                  }
-              }
-          }
-        ''}
-
-        ${optionalString (hasDependencies.project) ''
-          gradle.projectsLoaded {
-              allprojects {
-                  offlineRepo(repositories, "project", "${repos.project}")
-              }
-          }
-        ''}
-      '';
-
-  mkGradle = gradleSpec:
+  mkGradle =
+    gradleSpec:
    gradleGen.gradleGen {
      inherit (gradleSpec) nativeVersion;

      name = "gradle-${gradleSpec.version}-${gradleSpec.type}";

-      src = fetchurl {
-        inherit (gradleSpec) url sha256;
-      };
-    } // {
+      src = fetchurl { inherit (gradleSpec) url sha256; };
+    }
+    // {
      inherit (gradleSpec) version;
    };

@@ -264,9 +313,7 @@ let
    initScript = mkInitScript projectSpec gradle;
  };

-  gradleEnv = mapAttrs
-    (_: p: mkProjectEnv p)
-    (fromJSON (readFile envSpec));
+  gradleEnv = mapAttrs (_: p: mkProjectEnv p) (fromJSON (readFile envSpec));

  projectEnv = gradleEnv."";
  pname = args.pname or projectEnv.name;
@@ -282,37 +329,40 @@ let
      ${concatStringsSep " " flags}
  '';

-  buildIncludedProjects =
-    concatStringsSep "\n" (mapAttrsToList
-      (_: env: buildProject env [ "build" ])
-      (removeAttrs gradleEnv [ "" ]));
+  buildIncludedProjects = concatStringsSep "\n" (
+    mapAttrsToList (_: env: buildProject env [ "build" ]) (removeAttrs gradleEnv [ "" ])
+  );

  buildRootProject = buildProject projectEnv gradleFlags;
+in
+stdenv.mkDerivation (
+  args
+  // {

-in stdenv.mkDerivation (args // {
+    inherit pname version;

-  inherit pname version;
+    nativeBuildInputs = (args.nativeBuildInputs or [ ]) ++ [ projectEnv.gradle ];

-  nativeBuildInputs = (args.nativeBuildInputs or []) ++ [ projectEnv.gradle ];
+    buildPhase =
+      args.buildPhase or ''
+        runHook preBuild

-  buildPhase = args.buildPhase or ''
-    runHook preBuild
+        (
+        set -x

-    (
-    set -x
+        # use the init script here
+        TMPHOME=$(mktemp -d)
+        mkdir -p $TMPHOME/init.d
+        cp ${projectEnv.initScript} $TMPHOME/init.d

-    # use the init script here
-    TMPHOME=$(mktemp -d)
-    mkdir -p $TMPHOME/init.d
-    cp ${projectEnv.initScript} $TMPHOME/init.d
+        export "GRADLE_USER_HOME=$TMPHOME"
+        ${buildIncludedProjects}
+        ${buildRootProject}
+        )

-    export "GRADLE_USER_HOME=$TMPHOME"
-    ${buildIncludedProjects}
-    ${buildRootProject}
-    )
+        runHook postBuild
+      '';

-    runHook postBuild
-  '';
-
-  dontStrip = true;
-})
+    dontStrip = true;
+  }
+)
--- a/fixtures/projects/ivy/basic/kotlin/settings.gradle.kts
+++ b/fixtures/projects/ivy/basic/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/plugin/resolves-from-default-repo/kotlin/settings.gradle.kts
+++ b/fixtures/projects/plugin/resolves-from-default-repo/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/s3/maven-snapshot/kotlin/settings.gradle.kts
+++ b/fixtures/projects/s3/maven-snapshot/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/s3/maven/kotlin/settings.gradle.kts
+++ b/fixtures/projects/s3/maven/kotlin/settings.gradle.kts
@@ -0,0 +1 @@
+// Intentionally left empty
--- a/fixtures/projects/subprojects/multi-module/kotlin/settings.gradle.kts
+++ b/fixtures/projects/subprojects/multi-module/kotlin/settings.gradle.kts
@@ -1 +1 @@
-include(":child-a", ":child-b")
+include(":child-a", ":child-b")