INT-10098 - ingest project labels (#112)

docs/jupiterone.md

@@ -86,6 +86,7 @@ The following entities are created:
 | Commit        | `gitlab_commit`        | `CodeCommit`          |
 | Finding       | `gitlab_finding`       | `Finding`             |
 | Group         | `gitlab_group`         | `Group`               |
+| Label         | `gitlab_label`         | `Record`              |
 | Merge Request | `gitlab_merge_request` | `CodeReview`, `PR`    |
 | Project       | `gitlab_project`       | `CodeRepo`, `Project` |
 | User          | `gitlab_user`          | `User`                |
@@ -103,6 +104,7 @@ The following relationships are created:
 | `gitlab_group`         | **HAS**               | `gitlab_user`          |
 | `gitlab_merge_request` | **HAS**               | `gitlab_commit`        |
 | `gitlab_project`       | **HAS**               | `gitlab_finding`       |
+| `gitlab_project`       | **HAS**               | `gitlab_label`         |
 | `gitlab_project`       | **HAS**               | `gitlab_merge_request` |
 | `gitlab_project`       | **HAS**               | `gitlab_user`          |
 | `gitlab_user`          | **APPROVED**          | `gitlab_merge_request` |

src/constants.ts

@@ -19,6 +19,7 @@ export const Steps = {
   BUILD_PROJECT_HAS_PR: 'build-project-merge-request-relationships',
   BUILD_USER_OPENED_PR: 'build-user-opened-merge-request-relationships',
   BUILD_USER_APPROVED_PR: 'build-user-approved-merge-request-relationships',
+  PROJECT_LABELS: 'fetch-project-labels',
 };
 
 export const Entities = {
@@ -57,6 +58,11 @@ export const Entities = {
     _type: 'gitlab_project',
     _class: ['CodeRepo', 'Project'],
   },
+  LABEL: {
+    resourceName: 'Label',
+    _type: 'gitlab_label',
+    _class: ['Record'],
+  },
 };
 
 export const Relationships = {
@@ -126,4 +132,10 @@ export const Relationships = {
     _class: RelationshipClass.HAS,
     targetType: Entities.COMMIT._type,
   },
+  PROJECT_HAS_LABEL: {
+    _type: 'gitlab_project_has_label',
+    sourceType: Entities.PROJECT._type,
+    _class: RelationshipClass.HAS,
+    targetType: Entities.LABEL._type,
+  },
 };

src/converters/index.ts

@@ -12,6 +12,7 @@ import {
   GitLabProject,
   GitLabUser,
   GitLabFinding,
+  GitlabLabel,
 } from '../provider/types';
 import { getCommitWebLinkFromMergeRequest } from '../util/mergeRequest';
 
@@ -295,3 +296,35 @@ export function getNumericSeverity(severity: string | undefined) {
     return undefined;
   }
 }
+
+export function createLabelEntity(label: GitlabLabel): Entity {
+  const key = createLabelEntityIdentifier(label.id);
+
+  return createIntegrationEntity({
+    entityData: {
+      source: label,
+      assign: {
+        _key: key,
+        _type: Entities.LABEL._type,
+        _class: Entities.LABEL._class,
+        id: label.id.toString(),
+        displayName: label.name,
+        name: label.name,
+        description: label.description ?? undefined,
+        color: label.color,
+        textColor: label.text_color,
+        openIssuesCount: label.open_issues_count,
+        closedIssuesCount: label.closed_issues_count,
+        openMergeRequestsCount: label.open_merge_requests_count,
+        subscribed: label.subscribed,
+        priority: label.priority,
+      },
+    },
+  });
+}
+
+const LABEL_ID_PREFIX = 'gitlab-label';
+
+export function createLabelEntityIdentifier(id: number): string {
+  return `${LABEL_ID_PREFIX}:${id}`;
+}

src/provider/GitlabClient.ts

@@ -18,6 +18,7 @@ import {
   GitLabProject,
   GitLabUser,
   GitLabUserRef,
+  GitlabLabel,
 } from './types';
 
 /**
@@ -145,6 +146,17 @@ export class GitlabClient {
     );
   }
 
+  async iterateProjectLabels(
+    projectId: number,
+    iteratee: ResourceIteratee<GitlabLabel>,
+  ) {
+    return this.iterateResources(`/projects/${projectId}/labels`, iteratee, {
+      params: {
+        with_counts: 'true',
+      },
+    });
+  }
+
   /**
    * https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-configuration-1
    */

src/provider/types.ts

@@ -126,3 +126,18 @@ export type GitLabMergeRequestApproval = Opaque<
   any,
   'GitLabMergeRequestApproval'
 >;
+
+export interface GitlabLabel {
+  id: number;
+  color: string;
+  text_color: string;
+  name: string;
+  description?: string | null;
+  description_html?: string | null;
+  open_issues_count: number;
+  closed_issues_count: number;
+  open_merge_requests_count: number;
+  subscribed: boolean;
+  priority?: number;
+  is_project_label?: boolean | null;
+}