feat(composer): custom gitlab host auth (#8612)

Generates the COMPOSER_AUTH env variable for all gitlab host rules
renovatebot · May 6, 2021 · e49213a · e49213a
1 parent c9c961c
commit e49213a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 10 deletions.
diff --git a/lib/manager/composer/__snapshots__/artifacts.spec.ts.snap b/lib/manager/composer/__snapshots__/artifacts.spec.ts.snap
@@ -210,7 +210,7 @@ Array [
       "cwd": "/tmp/github/some/repo",
       "encoding": "utf-8",
       "env": Object {
-        "COMPOSER_AUTH": "{\\"github-oauth\\":{\\"github.com\\":\\"github-token\\"},\\"gitlab-token\\":{\\"gitlab.com\\":\\"gitlab-token\\"},\\"http-basic\\":{\\"packagist.renovatebot.com\\":{\\"username\\":\\"some-username\\",\\"password\\":\\"some-password\\"},\\"artifactory.yyyyyyy.com\\":{\\"username\\":\\"some-other-username\\",\\"password\\":\\"some-other-password\\"}}}",
+        "COMPOSER_AUTH": "{\\"github-oauth\\":{\\"github.com\\":\\"github-token\\"},\\"gitlab-token\\":{\\"gitlab.com\\":\\"gitlab-token\\"},\\"gitlab-domains\\":[\\"gitlab.com\\"],\\"http-basic\\":{\\"packagist.renovatebot.com\\":{\\"username\\":\\"some-username\\",\\"password\\":\\"some-password\\"},\\"artifactory.yyyyyyy.com\\":{\\"username\\":\\"some-other-username\\",\\"password\\":\\"some-other-password\\"}}}",
         "COMPOSER_CACHE_DIR": "/tmp/renovate/cache/others/composer",
         "HOME": "/home/user",
         "HTTPS_PROXY": "https://example.com",

diff --git a/lib/manager/composer/artifacts.ts b/lib/manager/composer/artifacts.ts
@@ -35,6 +35,7 @@ interface UserPass {
 interface AuthJson {
   'github-oauth'?: Record<string, string>;
   'gitlab-token'?: Record<string, string>;
+  'gitlab-domains'?: string[];
   'http-basic'?: Record<string, UserPass>;
 }
 
@@ -51,15 +52,20 @@ function getAuthJson(): string | null {
     };
   }
 
-  const gitlabCredentials = hostRules.find({
-    hostType: PLATFORM_TYPE_GITLAB,
-    url: 'https://gitlab.com/api/v4/',
-  });
-  if (gitlabCredentials?.token) {
-    authJson['gitlab-token'] = {
-      'gitlab.com': gitlabCredentials.token,
-    };
-  }
+  hostRules
+    .findAll({ hostType: PLATFORM_TYPE_GITLAB })
+    ?.forEach((gitlabHostRule) => {
+      if (gitlabHostRule?.token) {
+        const host = gitlabHostRule.hostName || 'gitlab.com';
+        authJson['gitlab-token'] = authJson['gitlab-token'] || {};
+        authJson['gitlab-token'][host] = gitlabHostRule.token;
+        // https://getcomposer.org/doc/articles/authentication-for-private-packages.md#gitlab-token
+        authJson['gitlab-domains'] = [
+          host,
+          ...(authJson['gitlab-domains'] || []),
+        ];
+      }
+    });
 
   hostRules
     .findAll({ hostType: datasourcePackagist.id })