@jupiterone/integration-sdk-cli 12.8.1 → 13.0.0

package/src/bocchi/templates/partials/stepMap.hbs

@@ -0,0 +1,47 @@
+{
+  id: Steps.{{constantCase id}},
+  name: '{{name}}',
+  entities: [Entities.{{constantCase entity.name}}],
+  relationships: [
+  {{#if parentAssociation}}
+    Relationships.{{#with (getStepByType parentAssociation.parentEntityType)}}{{constantCase entity.name}}{{/with}}_{{constantCase parentAssociation.relationshipClass}}_{{constantCase entity.name}},
+  {{/if}}
+  ],
+  dependsOn: [
+    {{#each dependsOn}}
+    Steps.{{constantCase this}},
+    {{/each}}
+  ],
+  executionHandler: {{camelCase id}},
+},
+{{#if directRelationships}}
+{{#with (getDirectRelationships this)}}
+{{#each this}}
+{
+  id: Steps.BUILD_{{constantCase sourceStep.entity.name}}_{{constantCase targetStep.entity.name}}_RELATIONSHIPS,
+  name: 'Build {{sourceStep.entity.name}} {{targetStep.entity.name}} Relationships',
+  entities: [],
+  relationships: [
+    Relationships.{{constantCase sourceStep.entity.name}}_{{constantCase relationshipClass}}_{{constantCase targetStep.entity.name}},
+  ],
+  dependsOn: [
+    Steps.{{constantCase sourceStep.id}},
+    Steps.{{constantCase targetStep.id}},
+  ],
+  executionHandler: build{{pascalCase sourceStep.entity.name}}{{pascalCase relationshipClass}}{{pascalCase targetStep.entity.name}}Relationships,
+},
+{{/each}}
+{{/with}}
+{{/if}}
+{{#if mappedRelationships}}
+{
+  id: Steps.BUILD_{{constantCase entity.name}}_MAPPED_RELATIONSHIPS,
+  name: 'Build {{entity.name}} Mapped Relationships',
+  entities: [],
+  relationships: [],
+  dependsOn: [
+    Steps.{{constantCase id}},
+  ],
+  executionHandler: build{{pascalCase entity.name}}MappedRelationships,
+},
+{{/if}}

package/src/bocchi/templates/steps/child-singleton.ts.hbs

@@ -0,0 +1,47 @@
+{{#with step}}
+import {
+  IntegrationStep,
+  IntegrationStepExecutionContext,
+  RelationshipClass,
+  {{#if directRelationships}}
+  createDirectRelationship,
+  {{/if}}
+  {{#if mappedRelationships}}
+  PrimitiveEntity,
+  RelationshipDirection,
+  createMappedRelationship,
+  {{/if}}
+} from '@jupiterone/integration-sdk-core';
+
+import { IntegrationConfig } from '../../config';
+import {
+  Steps,
+  Entities,
+  Relationships,
+} from '../constants';
+{{#if request}}import { createAPIClient } from '../../client';{{/if}}
+import { create{{pascalCase entity.name}}Entity } from '../converters';
+
+export const {{camelCase entity.name}}Steps: IntegrationStep<IntegrationConfig>[] = [
+  {{> stepMap }}
+];
+
+export async function {{camelCase id}}({
+  jobState,
+  instance,
+  logger
+}: IntegrationStepExecutionContext<IntegrationConfig>) {
+  const client = createAPIClient(instance.config, logger);
+
+  await jobState.iterateEntities(
+    { _type: '{{ parentAssociation.parentEntityType }}' },
+    async (parentEntity) => {
+      const data = await client.get{{pascalCase entity.name}}(parentEntity);
+      await jobState.addEntity(create{{pascalCase entity.name}}Entity(data));
+    }
+  );
+}
+
+{{> directRelationships}}
+{{> mappedRelationships}}
+{{/with}}

package/src/bocchi/templates/steps/fetch-child-entities.ts.hbs

@@ -0,0 +1,58 @@
+{{#with step}}
+import {
+  createDirectRelationship,
+  IntegrationStep,
+  IntegrationStepExecutionContext,
+  RelationshipClass,
+  {{#if directRelationships}}
+  createDirectRelationship,
+  {{/if}}
+  {{#if mappedRelationships}}
+  PrimitiveEntity,
+  RelationshipDirection,
+  createMappedRelationship,
+  {{/if}}
+} from '@jupiterone/integration-sdk-core';
+
+import { IntegrationConfig } from '../../config';
+import {
+  Steps,
+  Entities,
+  Relationships,
+} from '../constants';
+import { createAPIClient } from '../../client';
+import { create{{pascalCase entity.name}}Entity } from '../converters';
+
+export const {{camelCase entity.name}}Steps: IntegrationStep<IntegrationConfig>[] = [
+  {{> stepMap }}
+];
+
+export async function {{camelCase id}}({
+  instance,
+  jobState,
+  logger
+}: IntegrationStepExecutionContext<IntegrationConfig>): Promise<void> {
+  const client = createAPIClient(instance.config, logger);
+
+  await jobState.iterateEntities(
+    { _type: '{{ parentAssociation.parentEntityType }}' },
+    async (parentEntity) => {
+      await client.iterate{{pascalCase entity.name}}s(
+        parentEntity,
+        async (data) => {
+          const entity = await jobState.addEntity(create{{pascalCase entity.name}}Entity(data));
+
+          await jobState.addRelationship(createDirectRelationship({
+            from: parentEntity,
+            _class: RelationshipClass.{{ parentAssociation.relationshipClass }},
+            to: entity,
+          }));
+        },
+      );
+    }
+  );
+}
+
+{{> directRelationships}}
+{{> mappedRelationships}}
+{{/with}}

package/src/bocchi/templates/steps/fetch-entities.ts.hbs

@@ -0,0 +1,47 @@
+{{#with step}}
+import {
+  IntegrationStep,
+  IntegrationStepExecutionContext,
+  {{#if directRelationships}}
+  RelationshipClass,
+  createDirectRelationship,
+  {{/if}}
+  {{#if mappedRelationships}}
+  PrimitiveEntity,
+  RelationshipDirection,
+  createMappedRelationship,
+  {{/if}}
+} from '@jupiterone/integration-sdk-core';
+
+import { IntegrationConfig } from '../../config';
+import {
+  Steps,
+  Entities,
+  {{#if directRelationships}}
+  Relationships,
+  {{/if}}
+} from '../constants';
+import { createAPIClient } from '../../client';
+import { create{{pascalCase entity.name}}Entity } from '../converters';
+
+export const {{camelCase entity.name}}Steps: IntegrationStep<IntegrationConfig>[] = [
+  {{> stepMap }}
+];
+
+export async function {{camelCase id}}({
+  instance,
+  jobState,
+  logger
+}: IntegrationStepExecutionContext<IntegrationConfig>): Promise<void> {
+  const client = createAPIClient(instance.config, logger);
+
+  await client.iterate{{pascalCase entity.name}}s(
+    async (data) => {
+        await jobState.addEntity(create{{pascalCase entity.name}}Entity(data));
+    },
+  );
+}
+
+{{> directRelationships}}
+{{> mappedRelationships}}
+{{/with}}

package/src/bocchi/templates/steps/index.test.ts.hbs

@@ -0,0 +1,41 @@
+{{#with step}}
+import { executeStepWithDependencies } from '@jupiterone/integration-sdk-testing';
+
+import { buildStepTestConfigForStep } from '../../../test/config';
+import { Recording, setupProjectRecording } from '../../../test/recording';
+import { Steps } from '../constants';
+
+let recording: Recording;
+afterEach(async () => {
+  await recording.stop();
+});
+
+test('{{kebabCase id}}', async () => {
+  recording = setupProjectRecording({
+    directory: __dirname,
+    name: '{{kebabCase id}}',
+  });
+
+  const stepConfig = buildStepTestConfigForStep(Steps.{{constantCase id}});
+  const stepResult = await executeStepWithDependencies(stepConfig);
+  expect(stepResult).toMatchStepMetadata(stepConfig);
+});
+
+{{#if directRelationships}}
+{{#with (getDirectRelationships this)}}
+{{#each this}}
+test('build-{{kebabCase sourceStep.entity.name}}-{{kebabCase targetStep.entity.name}}-relationships', async () => {
+  recording = setupProjectRecording({
+    directory: __dirname,
+    name: 'build-{{kebabCase sourceStep.entity.name}}-{{kebabCase targetStep.entity.name}}-relationships',
+  });
+
+  const stepConfig = buildStepTestConfigForStep(Steps.BUILD_{{constantCase sourceStep.entity.name}}_{{constantCase targetStep.entity.name}}_RELATIONSHIPS);
+  const stepResult = await executeStepWithDependencies(stepConfig);
+  expect(stepResult).toMatchStepMetadata(stepConfig);
+});
+
+{{/each}}
+{{/with}}
+{{/if}}
+{{/with}}

package/src/bocchi/templates/steps/singleton.ts.hbs

@@ -0,0 +1,45 @@
+{{#with step}}
+import {
+  IntegrationStep,
+  IntegrationStepExecutionContext,
+  {{#if directRelationships}}
+  RelationshipClass,
+  createDirectRelationship,
+  {{/if}}
+  {{#if mappedRelationships}}
+  PrimitiveEntity,
+  RelationshipDirection,
+  createMappedRelationship,
+  {{/if}}
+} from '@jupiterone/integration-sdk-core';
+
+import { IntegrationConfig } from '../../config';
+import {
+  Steps,
+  Entities,
+  {{#if directRelationships}}
+  Relationships,
+  {{/if}}
+} from '../constants';
+{{#if request}}import { createAPIClient } from '../../client';{{/if}}
+import { create{{pascalCase entity.name}}Entity } from '../converters';
+
+export const {{camelCase entity.name}}Steps: IntegrationStep<IntegrationConfig>[] = [
+  {{> stepMap }}
+];
+
+export async function {{camelCase id}}({
+  jobState,
+  instance,
+}: IntegrationStepExecutionContext<IntegrationConfig>) {
+  {{#if request}}
+  const client = createAPIClient(instance.config);
+
+  const data = await client.get{{camelCase entity.name}}();
+  {{/if}}
+  await jobState.addEntity(create{{pascalCase entity.name}}Entity({{#if request}}data{{/if}}));
+}
+
+{{> directRelationships}}
+{{> mappedRelationships}}
+{{/with}}

package/src/bocchi/templates/steps/spec.ts.hbs

@@ -0,0 +1,73 @@
+{{#with step}}
+import {
+  RelationshipClass,
+  StepSpec,
+} from '@jupiterone/integration-sdk-core';
+import { IntegrationConfig } from '../../../src/config';
+
+export const {{camelCase entity.name}}Spec: StepSpec<IntegrationConfig>[] = [
+  {
+    id: '{{kebabCase id}}',
+    name: '{{name}}',
+    entities: [
+      {
+        resourceName: '{{entity.name}}',
+        _type: '{{entity._type}}',
+        _class: ['{{entity._class}}'],
+      }
+    ],
+    relationships: [
+      {{#if parentAssociation}}
+      {
+        sourceType: '{{parentAssociation.parentEntityType}}',
+        _class: RelationshipClass.{{constantCase parentAssociation.relationshipClass}},
+        targetType: '{{entity._type}}',
+        _type: '{{getRelationshipType parentAssociation.relationshipClass parentAssociation.parentEntityType entity._type}}',
+      },
+      {{/if}}
+    ],
+    dependsOn: [
+      {{#each dependsOn}}
+      '{{this}}',
+      {{/each}}
+    ],
+    implemented: true,
+  },
+{{#if directRelationships}}
+{{#with (getDirectRelationships this)}}
+{{#each this}}
+  {
+    id: 'build-{{kebabCase sourceStep.entity.name}}-{{kebabCase targetStep.entity.name}}-relationships',
+    name: 'Build {{sourceStep.entity.name}} {{targetStep.entity.name}} Relationships',
+    entities: [],
+    relationships: [
+      {
+        sourceType: '{{sourceStep.entity._type}}',
+        _class: RelationshipClass.{{constantCase relationshipClass}},
+        targetType: '{{targetStep.entity._type}}',
+        _type: '{{getRelationshipType relationshipClass sourceStep.entity._type targetStep.entity._type}}',
+      }
+    ],
+    dependsOn: [
+      '{{sourceStep.id}}',
+      '{{targetStep.id}}',
+    ],
+    implemented: true,
+  },
+{{/each}}
+{{/with}}
+{{/if}}
+{{#if mappedRelationships}}
+  {
+    id: 'build-{{kebabCase entity.name}}-mapped-relationships',
+    name: 'Build {{entity.name}} Mapped Relationships',
+    entities: [],
+    relationships: [],
+    dependsOn: [
+      '{{id}}',
+    ],
+    implemented: true,
+  },
+{{/if}}
+];
+{{/with}}

package/src/bocchi/templates/top-level/.env.example.hbs

@@ -0,0 +1,3 @@
+{{#each template.instanceConfigFields}}
+{{constantCase @key}}=
+{{/each}}

package/src/bocchi/templates/top-level/.eslintignore.hbs

@@ -0,0 +1 @@
+dist

package/src/bocchi/templates/top-level/.eslintrc.hbs

@@ -0,0 +1,6 @@
+{
+  "root": true,
+  "extends": [
+    "./node_modules/@jupiterone/integration-sdk-dev-tools/config/eslint.json"
+  ]
+}

package/src/bocchi/templates/top-level/.github/workflows/build.yml.hbs

@@ -0,0 +1,29 @@
+name: Build
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code repository source code
+        uses: actions/checkout@v3
+
+      - id: setup-node
+        name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Run tests
+        run: yarn test:ci
+
+      - name: Run build
+        run: yarn build

package/src/bocchi/templates/top-level/.github/workflows/questions.yml.hbs

@@ -0,0 +1,40 @@
+name: Questions
+on: [pull_request_target]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out `main` branch
+        uses: actions/checkout@v3
+        with:
+          path: source
+
+      - name: Check out target branch questions
+        uses: actions/checkout@v3
+        with:
+          ref: $\{{github.event.pull_request.head.ref}}
+          repository: $\{{github.event.pull_request.head.repo.full_name}}
+          path: target
+
+      - id: setup-node
+        name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+
+      - name: Install dependencies for `main` branch
+        run: yarn install --cwd source --frozen-lockfile
+
+      - name: Validate questions on target branch
+        env:
+          MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID:
+            $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID }}
+          MANAGED_QUESTIONS_JUPITERONE_API_KEY:
+            $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_API_KEY }}
+        run:
+          yarn --cwd source j1-integration validate-question-file -a
+          --frozen-lockfile $MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID -k
+          $MANAGED_QUESTIONS_JUPITERONE_API_KEY -p
+          ../target/jupiterone/questions/questions.yaml

package/src/bocchi/templates/top-level/.gitignore.hbs

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+.j1-integration/
+.j1-integration-cache/
+.env
+.eslintcache
+tsconfig.tsbuildinfo
+.npmrc

package/src/bocchi/templates/top-level/.node-version.hbs

@@ -0,0 +1 @@
+18

package/src/bocchi/templates/top-level/.prettierignore.hbs

@@ -0,0 +1,6 @@
+dist
+coverage/
+.j1-integration
+.j1-integration-cache
+.gitleaks.yml
+CHANGELOG.md

package/src/bocchi/templates/top-level/CHANGELOG.md.hbs

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]

package/src/bocchi/templates/top-level/CODEOWNERS.hbs

@@ -0,0 +1,3 @@
+* @jupiterone/integrations
+
+CODEOWNERS @jupiterone/security

package/src/bocchi/templates/top-level/Dockerfile.hbs

@@ -0,0 +1,25 @@
+FROM node:18-bullseye-slim as builder
+
+ENV JUPITERONE_INTEGRATION_DIR=/opt/jupiterone/integration
+
+COPY package.json yarn.lock tsconfig.dist.json tsconfig.json LICENSE ${JUPITERONE_INTEGRATION_DIR}/
+COPY src/ ${JUPITERONE_INTEGRATION_DIR}/src
+WORKDIR  ${JUPITERONE_INTEGRATION_DIR}
+RUN apt-get update && apt-get install -y python3 make g++ && rm -rf /var/lib/api/lists/*
+RUN yarn install
+RUN yarn build:docker
+
+
+FROM node:18-bullseye-slim
+ENV JUPITERONE_INTEGRATION_DIR=/opt/jupiterone/integration
+COPY --from=builder --chown=node:node ${JUPITERONE_INTEGRATION_DIR}/dist ${JUPITERONE_INTEGRATION_DIR}
+COPY --from=builder --chown=node:node ${JUPITERONE_INTEGRATION_DIR}/yarn.lock ${JUPITERONE_INTEGRATION_DIR}
+COPY scripts/ ${JUPITERONE_INTEGRATION_DIR}/scripts
+WORKDIR ${JUPITERONE_INTEGRATION_DIR}
+RUN apt-get update && apt-get install -y python3
+RUN yarn install --production --fronzen-lockfile --cache-folder ./ycache && yarn global add --cache-folder ./ycache @jupiterone/integration-sdk-cli && rm -rf ./ycache  && chown -R node:node /opt/jupiterone
+RUN export PATH="$(yarn global bin):$PATH"
+
+USER node
+
+CMD ["sh", "scripts/execute.sh"]