Merge pull request #1721 from forrestwaters/gitlab_private

Add ingestor for private gitlab repositories
2020-07-27 13:32:27 +02:00
parent f38a35d6ba a0787d59a4
commit 6b4ef4c1ce
3 changed files with 229 additions and 0 deletions
@@ -27,6 +27,7 @@ import { EntityPolicyProcessor } from './processors/EntityPolicyProcessor';
 import { FileReaderProcessor } from './processors/FileReaderProcessor';
 import { GithubReaderProcessor } from './processors/GithubReaderProcessor';
 import { GithubApiReaderProcessor } from './processors/GithubApiReaderProcessor';
+import { GitlabApiReaderProcessor } from './processors/GitlabApiReaderProcessor';
 import { GitlabReaderProcessor } from './processors/GitlabReaderProcessor';
 import { LocationRefProcessor } from './processors/LocationEntityProcessor';
 import * as result from './processors/results';
@@ -59,6 +60,7 @@ export class LocationReaders implements LocationReader {
      new FileReaderProcessor(),
      new GithubReaderProcessor(),
      new GithubApiReaderProcessor(),
+      new GitlabApiReaderProcessor(),
      new GitlabReaderProcessor(),
      new YamlProcessor(),
      new EntityPolicyProcessor(entityPolicy),
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { GitlabApiReaderProcessor } from './GitlabApiReaderProcessor';
+
+describe('GitlabApiReaderProcessor', () => {
+  it('should build raw api', () => {
+    const processor = new GitlabApiReaderProcessor();
+
+    const tests = [
+      {
+        target:
+          'https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path/to/file.yaml',
+        url: new URL(
+          'https://gitlab.com/api/v4/projects/12345/repository/files/my%2Fpath%2Fto%2Ffile.yaml?ref=branch',
+        ),
+        err: undefined,
+      },
+      {
+        target:
+          'https://gitlab.example.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/my/path/to/file.yaml',
+        url: new URL(
+          'https://gitlab.example.com/api/v4/projects/12345/repository/files/my%2Fpath%2Fto%2Ffile.yaml?ref=branch',
+        ),
+        err: undefined,
+      },
+      {
+        target:
+          'https://gitlab.com/groupA/teams/teamA/repoA/-/blob/branch/my/path/to/file.yaml', // Repo not in subgroup
+        url: new URL(
+          'https://gitlab.example.com/api/v4/projects/12345/repository/files/my%2Fpath%2Fto%2Ffile.yaml?ref=branch',
+        ),
+        err: undefined,
+      },
+      {
+        target:
+          'https://gitlab.com/groupA/teams/teamA/repoA/-/blob/branch/my/path/',
+        url: null,
+        err:
+          'Incorrect url: https://gitlab.com/groupA/teams/teamA/repoA/-/blob/branch/my/path/, Error: Gitlab url does not end in .ya?ml',
+      },
+    ];
+
+    for (const test of tests) {
+      if (test.err) {
+        expect(() => processor.buildRawUrl(test.target, 12345)).toThrowError(
+          test.err,
+        );
+      } else {
+        expect(processor.buildRawUrl(test.target, 12345)).toEqual(test.url);
+      }
+    }
+  });
+
+  it('should return request options', () => {
+    const tests = [
+      {
+        token: '0123456789',
+        expect: {
+          headers: {
+            'PRIVATE-TOKEN': '0123456789',
+          },
+        },
+      },
+      {
+        token: '',
+        expect: {
+          headers: {
+            'PRIVATE-TOKEN': '',
+          },
+        },
+      },
+    ];
+
+    for (const test of tests) {
+      process.env.GITLAB_PRIVATE_TOKEN = test.token;
+      const processor = new GitlabApiReaderProcessor();
+      expect(processor.getRequestOptions()).toEqual(test.expect);
+    }
+  });
+});
@@ -0,0 +1,133 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { LocationSpec } from '@backstage/catalog-model';
+import fetch, { RequestInit, HeadersInit } from 'node-fetch';
+import * as result from './results';
+import { LocationProcessor, LocationProcessorEmit } from './types';
+
+export class GitlabApiReaderProcessor implements LocationProcessor {
+  private privateToken: string = process.env.GITLAB_PRIVATE_TOKEN || '';
+
+  getRequestOptions(): RequestInit {
+    const headers: HeadersInit = { 'PRIVATE-TOKEN': '' };
+    if (this.privateToken !== '') {
+      headers['PRIVATE-TOKEN'] = this.privateToken;
+    }
+
+    const requestOptions: RequestInit = {
+      headers,
+    };
+
+    return requestOptions;
+  }
+
+  async readLocation(
+    location: LocationSpec,
+    optional: boolean,
+    emit: LocationProcessorEmit,
+  ): Promise<boolean> {
+    if (location.type !== 'gitlab/api') {
+      return false;
+    }
+
+    try {
+      const projectID = await this.getProjectID(location.target);
+      const url = this.buildRawUrl(location.target, projectID);
+      const response = await fetch(url.toString(), this.getRequestOptions());
+      if (response.ok) {
+        const data = await response.buffer();
+        emit(result.data(location, data));
+      } else {
+        const message = `${location.target} could not be read as ${url}, ${response.status} ${response.statusText}`;
+        if (response.status === 404) {
+          if (!optional) {
+            emit(result.notFoundError(location, message));
+          }
+        } else {
+          emit(result.generalError(location, message));
+        }
+      }
+    } catch (e) {
+      const message = `Unable to read ${location.type} ${location.target}, ${e}`;
+      emit(result.generalError(location, message));
+    }
+    return true;
+  }
+
+  // convert https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
+  // to https://gitlab.com/api/v4/projects/<PROJECTID>/repository/files/filepath?ref=branch
+  buildRawUrl(target: string, projectID: Number): URL {
+    try {
+      const url = new URL(target);
+
+      const branchAndfilePath = url.pathname.split('/-/blob/')[1];
+
+      if (!branchAndfilePath.match(/\.ya?ml$/)) {
+        throw new Error('Gitlab url does not end in .ya?ml');
+      }
+
+      const [branch, ...filePath] = branchAndfilePath.split('/');
+
+      url.pathname = [
+        '/api/v4/projects',
+        projectID,
+        'repository/files',
+        encodeURIComponent(filePath.join('/')),
+        'raw',
+      ].join('/');
+      url.search = `?ref=${branch}`;
+
+      return url;
+    } catch (e) {
+      throw new Error(`Incorrect url: ${target}, ${e}`);
+    }
+  }
+
+  async getProjectID(target: string): Promise<Number> {
+    const url = new URL(target);
+
+    if (
+      // absPaths to gitlab files should contain /-/blob
+      // ex: https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath
+      !url.pathname.match(/\/\-\/blob\//)
+    ) {
+      throw new Error('Please provide full path to yaml file from Gitlab');
+    }
+    try {
+      const repo = url.pathname.split('/-/blob/')[0];
+
+      // Find ProjectID from url
+      // convert 'https://gitlab.com/groupA/teams/teamA/subgroupA/repoA/-/blob/branch/filepath'
+      // to 'https://gitlab.com/api/v4/projects/groupA%2Fteams%2FsubgroupA%2FteamA%2Frepo'
+      const repoIDLookup = new URL(
+        `${url.protocol + url.hostname}/api/v4/projects/${encodeURIComponent(
+          repo.replace(/^\//, ''),
+        )}`,
+      );
+      const response = await fetch(
+        repoIDLookup.toString(),
+        this.getRequestOptions(),
+      );
+      const projectIDJson = await response.json();
+      const projectID: Number = projectIDJson.id;
+
+      return projectID;
+    } catch (e) {
+      throw new Error(`Could not get Gitlab ProjectID for: ${target}, ${e}`);
+    }
+  }
+}