Merge pull request #556 from JupiterOne/storage-constants-refactor

Refactor storage bucket constants

src/getStepStartStates.ts

@@ -161,7 +161,7 @@ import {
   STEP_SPANNER_INSTANCE_DATABASES,
 } from './steps/spanner/constants';
 import { SqlAdminSteps, STEP_SQL_ADMIN_INSTANCES } from './steps/sql-admin';
-import { STEP_CLOUD_STORAGE_BUCKETS } from './steps/storage';
+import { StorageStepsSpec } from './steps/storage/constants';
 import { IntegrationConfig, SerializedIntegrationConfig } from './types';
 import { deserializeIntegrationConfig } from './utils/integrationConfig';
 import { isMasterOrganizationInstance } from './utils/isMasterOrganizationInstance';
@@ -305,7 +305,7 @@ function getDefaultStepStartStates(params: {
     [STEP_CLOUD_FUNCTIONS_SERVICE_ACCOUNT_RELATIONSHIPS]: { disabled: false },
     [STEP_CLOUD_FUNCTIONS_SOURCE_REPO_RELATIONSHIPS]: { disabled: false },
     [STEP_CLOUD_FUNCTIONS_STORAGE_BUCKET_RELATIONSHIPS]: { disabled: false },
-    [STEP_CLOUD_STORAGE_BUCKETS]: { disabled: false },
+    [StorageStepsSpec.FETCH_STORAGE_BUCKETS.id]: { disabled: false },
     [STEP_IAM_CUSTOM_ROLES]: { disabled: false },
     [STEP_IAM_CUSTOM_ROLE_SERVICE_API_RELATIONSHIPS]: { disabled: false },
     [STEP_IAM_MANAGED_ROLES]: { disabled: false },
@@ -601,7 +601,7 @@ async function getStepStartStatesUsingServiceEnablements(params: {
     [STEP_CLOUD_FUNCTIONS_STORAGE_BUCKET_RELATIONSHIPS]: createStepStartState(
       ServiceUsageName.CLOUD_FUNCTIONS,
     ),
-    [STEP_CLOUD_STORAGE_BUCKETS]: createStepStartState(
+    [StorageStepsSpec.FETCH_STORAGE_BUCKETS.id]: createStepStartState(
       ServiceUsageName.STORAGE,
       ServiceUsageName.STORAGE_COMPONENT,
       ServiceUsageName.STORAGE_API,

src/index.test.ts

@@ -169,14 +169,14 @@ import {
   STEP_SPANNER_INSTANCE_DATABASES,
 } from './steps/spanner/constants';
 import { SqlAdminSteps, STEP_SQL_ADMIN_INSTANCES } from './steps/sql-admin';
-import { STEP_CLOUD_STORAGE_BUCKETS } from './steps/storage';
 import { IntegrationConfig } from './types';
 import {
   STEP_CLOUD_FUNCTIONS,
   STEP_CLOUD_FUNCTIONS_SERVICE_ACCOUNT_RELATIONSHIPS,
   STEP_CLOUD_FUNCTIONS_SOURCE_REPO_RELATIONSHIPS,
   STEP_CLOUD_FUNCTIONS_STORAGE_BUCKET_RELATIONSHIPS,
 } from './steps/functions';
+import { StorageStepsSpec } from './steps/storage/constants';
 
 interface ValidateInvocationInvalidConfigTestParams {
   instanceConfig?: Partial<IntegrationConfig>;
@@ -334,7 +334,7 @@ describe('#getStepStartStates success', () => {
         [STEP_CLOUD_FUNCTIONS_STORAGE_BUCKET_RELATIONSHIPS]: {
           disabled: false,
         },
-        [STEP_CLOUD_STORAGE_BUCKETS]: {
+        [StorageStepsSpec.FETCH_STORAGE_BUCKETS.id]: {
           disabled: false,
         },
         [STEP_IAM_CUSTOM_ROLES]: {

src/steps/app-engine/index.ts

@@ -40,16 +40,13 @@ import {
   createAppEngineVersionEntity,
 } from './converters';
 import { getCloudStorageBucketKey } from '../storage/converters';
-import {
-  CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
-  STEP_CLOUD_STORAGE_BUCKETS,
-} from '../storage';
 import {
   IAM_SERVICE_ACCOUNT_ENTITY_TYPE,
   GOOGLE_USER_ENTITY_TYPE,
   STEP_IAM_SERVICE_ACCOUNTS,
 } from '../iam/constants';
 import { isServiceAccountEmail } from '../../utils/iam';
+import { StorageEntitiesSpec, StorageStepsSpec } from '../storage/constants';
 
 async function withAppEngineErrorHandling<T>(
   logger: IntegrationLogger,
@@ -404,10 +401,13 @@ export const appEngineSteps: IntegrationStep<IntegrationConfig>[] = [
         _class: RelationshipClass.USES,
         _type: RELATIONSHIP_TYPE_APP_ENGINE_APPLICATION_USES_BUCKET,
         sourceType: ENTITY_TYPE_APP_ENGINE_APPLICATION,
-        targetType: CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+        targetType: StorageEntitiesSpec.STORAGE_BUCKET._type,
       },
     ],
-    dependsOn: [STEP_APP_ENGINE_APPLICATION, STEP_CLOUD_STORAGE_BUCKETS],
+    dependsOn: [
+      STEP_APP_ENGINE_APPLICATION,
+      StorageStepsSpec.FETCH_STORAGE_BUCKETS.id,
+    ],
     executionHandler: buildAppEngineApplicationUsesBucketRelationships,
   },
   {

src/steps/cloud-asset/index.test.ts

@@ -37,13 +37,11 @@ import {
   fetchBigQueryDatasets,
   BIG_QUERY_DATASET_ENTITY_TYPE,
 } from '../big-query';
-import {
-  fetchStorageBuckets,
-  CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
-} from '../storage';
+import { fetchStorageBuckets } from '../storage';
 import { CLOUD_FUNCTION_ENTITY_TYPE, fetchCloudFunctions } from '../functions';
 import { IAM_MANAGED_ROLES_DATA_JOB_STATE_KEY } from '../../utils/iam';
 import { fetchApiServices } from '../service-usage';
+import { StorageEntitiesSpec } from '../storage/constants';
 
 /* eslint-disable no-console */
 expect.extend({
@@ -660,7 +658,7 @@ describe('#fetchIamBindings', () => {
 
     await fetchStorageBuckets(context);
     const storageBuckets = context.jobState.collectedEntities.filter(
-      (e) => e._type === CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+      (e) => e._type === StorageEntitiesSpec.STORAGE_BUCKET._type,
     );
     expect(storageBuckets.length).toBeGreaterThan(0);
 

src/steps/cloud-build/constants.ts

@@ -1,6 +1,6 @@
 import { RelationshipClass } from '@jupiterone/integration-sdk-core';
 import { CloudSourceRepositoriesEntitiesSpec } from '../cloud-source-repositories/constants';
-import { CLOUD_STORAGE_BUCKET_ENTITY_TYPE } from '../storage';
+import { StorageEntitiesSpec } from '../storage/constants';
 
 export const CloudBuildEntitiesSpec = {
   BUILD: {
@@ -52,7 +52,7 @@ export const CloudBuildRelationshipsSpec = {
     _type: 'google_cloud_build_uses_storage_bucket',
     _class: RelationshipClass.USES,
     sourceType: CloudBuildEntitiesSpec.BUILD._type,
-    targetType: CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+    targetType: StorageEntitiesSpec.STORAGE_BUCKET._type,
   },
   BUILD_USES_SOURCE_REPOSITORY: {
     _type: 'google_cloud_build_uses_source_repository',

src/steps/cloud-build/steps/build-cloud-build-uses-storage-bucket-relationships.ts

@@ -6,7 +6,7 @@ import {
 } from '@jupiterone/integration-sdk-core';
 import { cloudbuild_v1 } from 'googleapis';
 import { IntegrationConfig, IntegrationStepContext } from '../../../types';
-import { STEP_CLOUD_STORAGE_BUCKETS } from '../../storage';
+import { StorageStepsSpec } from '../../storage/constants';
 import {
   CloudBuildEntitiesSpec,
   CloudBuildRelationshipsSpec,
@@ -20,7 +20,7 @@ export const buildCloudBuildUsesStorageBucketRelationshipsStep: IntegrationStep<
     relationships: [CloudBuildRelationshipsSpec.BUILD_USES_STORAGE_BUCKET],
     dependsOn: [
       CloudBuildStepsSpec.FETCH_BUILDS.id,
-      STEP_CLOUD_STORAGE_BUCKETS,
+      StorageStepsSpec.FETCH_STORAGE_BUCKETS.id,
     ],
     executionHandler: async function (context: IntegrationStepContext) {
       const { jobState } = context;

src/steps/compute/index.test.ts

@@ -38,10 +38,7 @@ import {
   buildComputeBackendBucketHasBucketRelationships,
   buildImageUsesKmsRelationships,
 } from '.';
-import {
-  CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
-  fetchStorageBuckets,
-} from '../storage';
+import { fetchStorageBuckets } from '../storage';
 import { integrationConfig } from '../../../test/config';
 import {
   ENTITY_TYPE_COMPUTE_DISK,
@@ -109,6 +106,7 @@ import { fetchIamServiceAccounts } from '../iam';
 import { fetchKmsCryptoKeys, fetchKmsKeyRings } from '../kms';
 import { filterGraphObjects } from '../../../test/helpers/filterGraphObjects';
 import { separateDirectMappedRelationships } from '../../../test/helpers/separateDirectMappedRelationships';
+import { StorageEntitiesSpec } from '../storage/constants';
 
 const tempNewAccountConfig = {
   ...integrationConfig,
@@ -1510,7 +1508,7 @@ describe('#fetchComputeBackendBuckets', () => {
 
     expect(
       context.jobState.collectedEntities.filter(
-        (e) => e._type === CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+        (e) => e._type === StorageEntitiesSpec.STORAGE_BUCKET._type,
       ),
     ).toMatchGraphObjectSchema({
       _class: ['DataStore'],

src/steps/compute/index.ts

@@ -179,10 +179,6 @@ import {
   getFirewallRelationshipDirection,
   processFirewallRuleRelationshipTargets,
 } from '../../utils/firewall';
-import {
-  CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
-  STEP_CLOUD_STORAGE_BUCKETS,
-} from '../storage';
 import { getCloudStorageBucketKey } from '../storage/converters';
 import { publishMissingPermissionEvent } from '../../utils/events';
 import { parseRegionNameFromRegionUrl } from '../../google-cloud/regions';
@@ -201,6 +197,7 @@ import {
   setNetworkPeerings,
   setPeeredNetworks,
 } from '../../utils/jobState';
+import { StorageEntitiesSpec, StorageStepsSpec } from '../storage/constants';
 
 export * from './constants';
 
@@ -1028,7 +1025,7 @@ export async function fetchComputeAddresses(
 
   await client.iterateComputeAddresses(async (address) => {
     const addressEntity = await jobState.addEntity(
-      createComputeAddressEntity(address, client.projectId)
+      createComputeAddressEntity(address, client.projectId),
     );
 
     // Subnetwork -> HAS -> Compute Address
@@ -2578,10 +2575,13 @@ export const computeSteps: IntegrationStep<IntegrationConfig>[] = [
         _class: RelationshipClass.HAS,
         _type: RELATIONSHIP_TYPE_BACKEND_BUCKET_HAS_STORAGE_BUCKET,
         sourceType: ENTITY_TYPE_COMPUTE_BACKEND_BUCKET,
-        targetType: CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+        targetType: StorageEntitiesSpec.STORAGE_BUCKET._type,
       },
     ],
-    dependsOn: [STEP_COMPUTE_BACKEND_BUCKETS, STEP_CLOUD_STORAGE_BUCKETS],
+    dependsOn: [
+      STEP_COMPUTE_BACKEND_BUCKETS,
+      StorageStepsSpec.FETCH_STORAGE_BUCKETS.id,
+    ],
     executionHandler: buildComputeBackendBucketHasBucketRelationships,
   },
   {

src/steps/dataproc/index.test.ts

@@ -18,13 +18,11 @@ import {
   RELATIONSHIP_TYPE_DATAPROC_CLUSTER_USES_STORAGE_BUCKET,
 } from './constants';
 import { fetchKmsCryptoKeys, fetchKmsKeyRings } from '../kms';
-import {
-  CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
-  fetchStorageBuckets,
-} from '../storage';
+import { fetchStorageBuckets } from '../storage';
 import { ENTITY_TYPE_COMPUTE_IMAGE, fetchComputeImages } from '../compute';
 import { separateDirectMappedRelationships } from '../../../test/helpers/separateDirectMappedRelationships';
 import { omitNewRegionsFromTests } from '../../../test/regions';
+import { StorageEntitiesSpec } from '../storage/constants';
 
 beforeAll(() => omitNewRegionsFromTests());
 
@@ -416,7 +414,7 @@ describe('#createClusterStorageRelationships', () => {
 
     expect(
       context.jobState.collectedEntities.filter(
-        (e) => e._type === CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+        (e) => e._type === StorageEntitiesSpec.STORAGE_BUCKET._type,
       ),
     ).toMatchGraphObjectSchema({
       _class: ['DataStore'],

src/steps/dataproc/index.ts

@@ -11,10 +11,7 @@ import { IntegrationConfig, IntegrationStepContext } from '../../types';
 import { getKmsGraphObjectKeyFromKmsKeyName } from '../../utils/kms';
 import { ENTITY_TYPE_COMPUTE_IMAGE, STEP_COMPUTE_IMAGES } from '../compute';
 import { ENTITY_TYPE_KMS_KEY, STEP_CLOUD_KMS_KEYS } from '../kms';
-import {
-  CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
-  STEP_CLOUD_STORAGE_BUCKETS,
-} from '../storage';
+import { StorageEntitiesSpec, StorageStepsSpec } from '../storage/constants';
 import { getCloudStorageBucketKey } from '../storage/converters';
 import { DataProcClient } from './client';
 import {
@@ -240,10 +237,13 @@ export const dataprocSteps: IntegrationStep<IntegrationConfig>[] = [
         _class: RelationshipClass.USES,
         _type: RELATIONSHIP_TYPE_DATAPROC_CLUSTER_USES_STORAGE_BUCKET,
         sourceType: ENTITY_TYPE_DATAPROC_CLUSTER,
-        targetType: CLOUD_STORAGE_BUCKET_ENTITY_TYPE,
+        targetType: StorageEntitiesSpec.STORAGE_BUCKET._type,
       },
     ],
-    dependsOn: [STEP_DATAPROC_CLUSTERS, STEP_CLOUD_STORAGE_BUCKETS],
+    dependsOn: [
+      STEP_DATAPROC_CLUSTERS,
+      StorageStepsSpec.FETCH_STORAGE_BUCKETS.id,
+    ],
     executionHandler: createClusterStorageRelationships,
   },
 ];