about summary refs log tree commit diff
path: root/nixpkgs/pkgs/development/go-modules/generic/default.nix
blob: 8a7deff2e730d0058d02a697f8b350313af0bcef (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
{ go, cacert, git, lib, removeReferencesTo, stdenv }:

let
  buildGoPackage =
    { name ? "${args'.pname}-${args'.version}"
    , src
    , buildInputs ? []
    , nativeBuildInputs ? []
    , passthru ? {}
    , patches ? []

    # A function to override the go-modules derivation
    , overrideModAttrs ? (_oldAttrs : {})

    # modSha256 is the sha256 of the vendored dependencies
    , modSha256

    # We want parallel builds by default
    , enableParallelBuilding ? true

    # Disabled flag
    , disabled ? false

    # Do not enable this without good reason
    # IE: programs coupled with the compiler
    , allowGoReference ? false

    , meta ? {}

    , ... }@args':

    with builtins;

    let
      args = removeAttrs args' [ "overrideModAttrs" "modSha256" "disabled" ];

      removeReferences = [ ] ++ lib.optional (!allowGoReference) go;

      removeExpr = refs: ''remove-references-to ${lib.concatMapStrings (ref: " -t ${ref}") refs}'';

      go-modules = go.stdenv.mkDerivation (let modArgs = {
        name = "${name}-go-modules";

        nativeBuildInputs = [ go git cacert ];

        inherit (args) src;
        inherit (go) GOOS GOARCH;

        patches = args.patches or [];

        GO111MODULE = "on";

        impureEnvVars = lib.fetchers.proxyImpureEnvVars ++ [
          "GIT_PROXY_COMMAND" "SOCKS_SERVER"
        ];

        configurePhase = args.modConfigurePhase or ''
          runHook preConfigure

          export GOCACHE=$TMPDIR/go-cache
          export GOPATH="$TMPDIR/go"
          mkdir -p "''${GOPATH}/pkg/mod/cache/download"

          runHook postConfigure
        '';

        buildPhase = args.modBuildPhase or ''
          runHook preBuild

          go mod download

          runHook postBuild
        '';

        installPhase = args.modInstallPhase or ''
          runHook preInstall

          cp -r "''${GOPATH}/pkg/mod/cache/download" $out

          runHook postInstall
        '';

        dontFixup = true;
        outputHashMode = "recursive";
        outputHashAlgo = "sha256";
        outputHash = modSha256;
      }; in modArgs // overrideModAttrs modArgs);

      package = go.stdenv.mkDerivation (args // {
        nativeBuildInputs = [ removeReferencesTo go ] ++ nativeBuildInputs;

        inherit (go) GOOS GOARCH;

        GO111MODULE = "on";

        configurePhase = args.configurePhase or ''
          runHook preConfigure

          export GOCACHE=$TMPDIR/go-cache
          export GOPATH="$TMPDIR/go"
          export GOPROXY=file://${go-modules}

          runHook postConfigure
        '';

        buildPhase = args.buildPhase or ''
          runHook preBuild

          buildGoDir() {
            local d; local cmd;
            cmd="$1"
            d="$2"
            . $TMPDIR/buildFlagsArray
            echo "$d" | grep -q "\(/_\|examples\|Godeps\|testdata\)" && return 0
            [ -n "$excludedPackages" ] && echo "$d" | grep -q "$excludedPackages" && return 0
            local OUT
            if ! OUT="$(go $cmd $buildFlags "''${buildFlagsArray[@]}" -v -p $NIX_BUILD_CORES $d 2>&1)"; then
              if ! echo "$OUT" | grep -qE '(no( buildable| non-test)?|build constraints exclude all) Go (source )?files'; then
                echo "$OUT" >&2
                return 1
              fi
            fi
            if [ -n "$OUT" ]; then
              echo "$OUT" >&2
            fi
            return 0
          }

          getGoDirs() {
            local type;
            type="$1"
            if [ -n "$subPackages" ]; then
              echo "$subPackages" | sed "s,\(^\| \),\1./,g"
            else
              find . -type f -name \*$type.go -exec dirname {} \; | grep -v "/vendor/" | sort --unique
            fi
          }

          if (( "''${NIX_DEBUG:-0}" >= 1 )); then
            buildFlagsArray+=(-x)
          fi

          if [ ''${#buildFlagsArray[@]} -ne 0 ]; then
            declare -p buildFlagsArray > $TMPDIR/buildFlagsArray
          else
            touch $TMPDIR/buildFlagsArray
          fi
          if [ -z "$enableParallelBuilding" ]; then
              export NIX_BUILD_CORES=1
          fi
          for pkg in $(getGoDirs ""); do
            echo "Building subPackage $pkg"
            buildGoDir install "$pkg"
          done
        '' + lib.optionalString (stdenv.hostPlatform != stdenv.buildPlatform) ''
          # normalize cross-compiled builds w.r.t. native builds
          (
            dir=$GOPATH/bin/${go.GOOS}_${go.GOARCH}
            if [[ -n "$(shopt -s nullglob; echo $dir/*)" ]]; then
              mv $dir/* $dir/..
            fi
            if [[ -d $dir ]]; then
              rmdir $dir
            fi
          )
        '' + ''
          runHook postBuild
        '';

        doCheck = args.doCheck or false;
        checkPhase = args.checkPhase or ''
          runHook preCheck

          for pkg in $(getGoDirs test); do
            buildGoDir test "$pkg"
          done

          runHook postCheck
        '';

        installPhase = args.installPhase or ''
          runHook preInstall

          mkdir -p $out
          dir="$GOPATH/bin"
          [ -e "$dir" ] && cp -r $dir $out

          runHook postInstall
        '';

        preFixup = (args.preFixup or "") + ''
          find $out/bin -type f -exec ${removeExpr removeReferences} '{}' + || true
        '';

        disallowedReferences = lib.optional (!allowGoReference) go;

        passthru = passthru // { inherit go go-modules; };

        meta = {
          # Add default meta information
          platforms = go.meta.platforms or lib.platforms.all;
        } // meta // {
          # add an extra maintainer to every package
          maintainers = (meta.maintainers or []) ++
                        [ lib.maintainers.kalbasit ];
        };
      }) // {
        overrideGoAttrs = f: buildGoPackage (args' // (f args'));
      };
    in if disabled then
      throw "${package.name} not supported for go ${go.meta.branch}"
    else
      package;
in
  buildGoPackage