Merge pull request #20 from cloudgraphdev/feature/CG-1312-support-essentialContacts

Feature/cg 1312 support essential contacts

Author: tyler-dunkel

README.md

@@ -90,6 +90,7 @@ CloudGraph GCP Provider will ask you what regions you would like to crawl and wi
 | kmsCryptoKeys                         | aiPlatformNotebooks, iamPolicy, kmsKeyRing, project                                                                                 |
 | dnsManagedZone                        | project                                                                                                                             |
 | dnsPolicy                             | project, network                                                                                                                    |
+| essentialContacts                     | project                                                                                                                             |
 | firestoreDatabases                    | project                                                                                                                             |
 | firewall                              | network, project                                                                                                                    |
 | folder                                | iamPolicy, organization, project                                                                                                    |
@@ -105,10 +106,10 @@ CloudGraph GCP Provider will ask you what regions you would like to crawl and wi
 | secretManager                         | project                                                                                                                             |
 | serviceAccounts                       | project                                                                                                                             |
 | sqlInstances                          | project, network                                                                                                                    |
-| sslPolicies                           | project, targetHttpsProxies, targetSslProxies                                                                                                                    |
+| sslPolicies                           | project, targetHttpsProxies, targetSslProxies                                                                                       |
 | storageBucket                         | project                                                                                                                             |
 | subnet                                | project, network, vmInstance, vpcConnectors, aiPlatformNotebooks                                                                    |
-| targetSslProxies                      | project, sslPolicies                                                                                                                         |
-| targetHttpsProxies                    | project, sslPolicies                                                                                                                         |
+| targetSslProxies                      | project, sslPolicies                                                                                                                |
+| targetHttpsProxies                    | project, sslPolicies                                                                                                                |
 | vmInstance                            | project, network, subnet                                                                                                            |
 | vpcConnectors                         | cloudFunction, project, network, subnet                                                                                             |

package.json

@@ -42,6 +42,7 @@
     "@google-cloud/dataproc": "^3.2.0",
     "@google-cloud/datastore": "^6.6.2",
     "@google-cloud/dns": "^2.2.3",
+    "@google-cloud/essential-contacts": "^2.0.2",
     "@google-cloud/firestore": "^5.0.2",
     "@google-cloud/functions": "^1.2.0",
     "@google-cloud/kms": "^2.10.0",

src/enums/schemasMap.ts

@@ -53,5 +53,6 @@ export default {
   [services.apiGatewayApi]: 'gcpApiGatewayApi',
   [services.apiGatewayApiConfig]: 'gcpApiGatewayApiConfig',
   [services.firestoreDatabase]: 'gcpFirestoreDatabase',
+  [services.essentialContacts]: 'gcpEssentialContact',
   tag: 'gcpTag',
 }

src/enums/serviceMap.ts

@@ -50,6 +50,7 @@ import GcpFirestoreDatabase from '../services/firestore'
 import GcpLabel from '../services/label'
 import GcpTag from '../services/tag'
 import GcpBilling from '../services/billing'
+import GcpEssentialContacts from '../services/essentialContacts'
 
 /**
  * serviceMap is an object that contains all currently supported services
@@ -105,6 +106,7 @@ export default {
   [services.apiGatewayApi]: GcpApiGatewayApi,
   [services.apiGatewayApiConfig]: GcpApiGatewayApiConfig,
   [services.firestoreDatabase]: GcpFirestoreDatabase,
+  [services.essentialContacts]: GcpEssentialContacts,
   label: GcpLabel,
   tag: GcpTag,
 }

src/enums/services.ts

@@ -75,7 +75,7 @@ export default {
   // cloudShell: 'cloud-shell',
   // debug: 'debug',
   // deploymentManager: 'deployment-manager',
-  // essentialContacts: 'essential-contacts',
+  essentialContacts: 'essentialContacts',
   logBucket: 'logBucket',
   logMetric: 'logMetric',
   logSink: 'logSink',

src/services/essentialContacts/data.ts

@@ -0,0 +1,55 @@
+import { EssentialContactsServiceClient } from '@google-cloud/essential-contacts'
+import { google } from '@google-cloud/essential-contacts/build/protos/protos'
+import CloudGraph from '@cloudgraph/sdk'
+import groupBy from 'lodash/groupBy'
+import gcpLoggerText from '../../properties/logger'
+import { GcpServiceInput } from '../../types'
+import { initTestEndpoint, generateGcpErrorLog } from '../../utils'
+import { GLOBAL_REGION } from '../../config/constants'
+
+const lt = { ...gcpLoggerText }
+const { logger } = CloudGraph
+const serviceName = 'EssentialContacts'
+const apiEndpoint = initTestEndpoint(serviceName)
+
+export interface RawGcpEssentialContact extends google.cloud.essentialcontacts.v1.IContact {
+  id: string
+  projectId: string
+  region: string
+}
+
+export default async ({
+  config,
+}: GcpServiceInput): Promise<{
+  [region: string]: RawGcpEssentialContact[]
+}> =>
+  new Promise(async resolve => {
+    const essentialContactList: RawGcpEssentialContact[] = []
+    const { projectId } = config
+
+    /**
+     * Get all EssentialContacts
+     */
+    try {
+      const essentialContactsClient = new EssentialContactsServiceClient({ ...config, apiEndpoint });
+      const iterable = essentialContactsClient.listContactsAsync({
+        parent: `projects/${projectId}`,
+      })
+
+      for await (const response of iterable) {
+        if (response) {
+          essentialContactList.push({
+            id: response.name,
+            projectId,
+            region: GLOBAL_REGION,
+            ...response,
+          })
+        }
+      }
+    } catch (error) {
+      generateGcpErrorLog(serviceName, 'essentialContacts:listContactsAsync', error)
+    }
+    
+    logger.debug(lt.foundResources(serviceName, essentialContactList.length))
+    resolve(groupBy(essentialContactList, 'region'))
+  })

src/services/essentialContacts/format.ts

@@ -0,0 +1,38 @@
+import { google } from '@google-cloud/essential-contacts/build/protos/protos'
+import { GcpEssentialContact } from '../../types/generated'
+import { RawGcpEssentialContact } from './data'
+import { toISOString } from '../../utils/dateutils'
+import { enumKeyToString } from '../../utils/format'
+
+export default ({
+  service,
+}: {
+  service: RawGcpEssentialContact
+  region: string
+}): GcpEssentialContact => {
+  const {
+    id,
+    projectId,
+    region,
+    name,
+    email,
+    notificationCategorySubscriptions,
+    languageTag,
+    validationState,
+    validateTime,
+  } = service
+
+  return {
+    id,
+    projectId,
+    region,
+    name,
+    email,
+    notificationCategorySubscriptions: notificationCategorySubscriptions.map(subscription => 
+      enumKeyToString(google.cloud.essentialcontacts.v1.NotificationCategory, subscription)
+    ),
+    languageTag,
+    validationState: enumKeyToString(google.cloud.essentialcontacts.v1.ValidationState, validationState),
+    validateTime: toISOString(validateTime?.seconds?.toString()),
+  }
+}

src/services/essentialContacts/index.ts

@@ -0,0 +1,13 @@
+import { Service } from '@cloudgraph/sdk'
+import BaseService from '../base'
+import format from './format'
+import getData from './data'
+import mutation from './mutation'
+
+export default class GcpEssentialContacts extends BaseService implements Service {
+  format = format.bind(this)
+
+  getData = getData.bind(this)
+
+  mutation = mutation
+}

src/services/essentialContacts/mutation.ts

@@ -0,0 +1,5 @@
+export default `mutation($input: [AddgcpEssentialContactInput!]!) {
+  addgcpEssentialContact(input: $input, upsert: true) {
+    numUids
+  }
+}`;

src/services/essentialContacts/schema.graphql

@@ -0,0 +1,14 @@
+type gcpEssentialContact implements gcpBaseResource
+  @generate(
+    query: { get: true, query: true, aggregate: true }
+    mutation: { add: true, delete: false }
+    subscription: false
+  )
+  @key(fields: "id") {
+    email: String @search(by: [hash, regexp])
+    notificationCategorySubscriptions: [String] @search(by: [hash])
+    languageTag: String @search(by: [hash, regexp])
+    validationState: String @search(by: [hash, regexp])
+    validateTime: String @search(by: [hash, regexp])
+    project: [gcpProject] @hasInverse(field: essentialContacts)
+}