feat(DirectLink): add the authentication_key for BGP MD5 authentication in directlink service

1. Add the option to add the authentication_key while approving provider created gateways
2. Add the authentication_key in the response while fetching gateways

Author: ajay-malhotra1

direct-link/v1.ts

@@ -368,6 +368,14 @@ class DirectLinkV1 extends BaseService {
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.id - Direct Link Connect gateway identifier.
    * @param {string} params.action - Action request.
+   * @param {GatewayActionTemplateAuthenticationKey} [params.authenticationKey] - BGP MD5 authentication key.
+   *
+   * BGP MD5 keys must be type=standard.
+   *
+   * The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters
+   * in length.
+   *
+   * To clear the optional `authentication_key` field patch its crn to `""`.
    * @param {boolean} [params.global] - Required for create_gateway_approve requests to select the gateway's routing
    * option.  Gateways with global routing (`true`) can connect to networks outside of their associated region.
    * @param {boolean} [params.metered] - Required for create_gateway_approve requests to select the gateway's metered
@@ -394,6 +402,7 @@ class DirectLinkV1 extends BaseService {
 
       const body = {
         'action': _params.action,
+        'authentication_key': _params.authenticationKey,
         'global': _params.global,
         'metered': _params.metered,
         'resource_group': _params.resourceGroup,
@@ -1279,6 +1288,16 @@ namespace DirectLinkV1 {
     id: string;
     /** Action request. */
     action: CreateGatewayActionConstants.Action | string;
+    /** BGP MD5 authentication key.
+     *
+     *  BGP MD5 keys must be type=standard.
+     *
+     *  The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII
+     *  characters in length.
+     *
+     *  To clear the optional `authentication_key` field patch its crn to `""`.
+     */
+    authenticationKey?: GatewayActionTemplateAuthenticationKey;
     /** Required for create_gateway_approve requests to select the gateway's routing option.  Gateways with global
      *  routing (`true`) can connect to networks outside of their associated region.
      */
@@ -1517,6 +1536,16 @@ namespace DirectLinkV1 {
 
   /** gateway. */
   export interface Gateway {
+    /** BGP MD5 authentication key.
+     *
+     *  BGP MD5 keys must be type=standard.
+     *
+     *  The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII
+     *  characters in length.
+     *
+     *  To clear the optional `authentication_key` field patch its crn to `""`.
+     */
+    authentication_key?: GatewayAuthenticationKey;
     /** Customer BGP ASN. */
     bgp_asn: number;
     /** (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs.
@@ -1586,14 +1615,26 @@ namespace DirectLinkV1 {
     resource_group?: ResourceGroupReference;
     /** Gateway speed in megabits per second. */
     speed_mbps: number;
-    /** Gateway type. The list of enumerated values for this property may expand in the future. Code and processes
+    /** Offering type. The list of enumerated values for this property may expand in the future. Code and processes
      *  using this field  must tolerate unexpected values.
      */
     type: string;
     /** VLAN allocated for this gateway.  Only set for type=connect gateways. */
     vlan?: number;
   }
 
+  /** BGP MD5 authentication key. BGP MD5 keys must be type=standard. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`. */
+  export interface GatewayActionTemplateAuthenticationKey {
+    /** connectivity association key crn. */
+    crn: string;
+  }
+
+  /** BGP MD5 authentication key. BGP MD5 keys must be type=standard. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`. */
+  export interface GatewayAuthenticationKey {
+    /** connectivity association key crn. */
+    crn: string;
+  }
+
   /** GatewayChangeRequest. */
   export interface GatewayChangeRequest {
   }
@@ -1818,7 +1859,7 @@ namespace DirectLinkV1 {
     resource_group?: ResourceGroupIdentity;
     /** Gateway speed in megabits per second. */
     speed_mbps: number;
-    /** Gateway type. */
+    /** Offering type. */
     type: string;
   }
 

directlink.env.enc

@@ -600,4 +600,131 @@ describe('DirectLinkProviderV2', () => {
       }
     });
   });
+
+  // Skipping the below test until integration CRN is available for authentication_key
+  describe.skip('Direct Link Provider Gateways with Client API with authenticationKey', () => {
+    jest.setTimeout(timeout);
+
+    const gwName = 'NODE-INT-SDK-PROVIDER-' + timestamp;
+    const speedMbps = 1000;
+
+    let portId = '';
+    let gatewayId = '';
+
+    const params = {
+      name: gwName,
+      speedMbps,
+      bgpAsn: 64999,
+      metered: false,
+      customerAccountId: config.CUSTOMER_ACCT_ID,
+    };
+
+    it('should successfully get the provider port', async done => {
+      try {
+        const response = await dlProviderService.listProviderPorts({});
+        expect(response).toBeDefined();
+        expect(response.status).toEqual(200);
+
+        const { result } = response || {};
+        expect(result.ports.length).toBeGreaterThan(0);
+        portId = result.ports[0].id;
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+
+    it('should create a provider gateway', async done => {
+      try {
+        const response = await dlProviderService.createProviderGateway({
+          ...params,
+          port: { id: portId },
+        });
+        expect(response).toBeDefined();
+        expect(response.status).toEqual(201);
+        gatewayId = response.result.id;
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+
+    it('should successfully approve the provider created gateway', async done => {
+      try {
+        const response = await dlService.createGatewayAction({
+          id: gatewayId,
+          action: 'create_gateway_approve',
+          global: false,
+          metered: false,
+          authenticationKey: {
+            crn: config.AUTHENTICATION_KEY,
+          },
+        });
+
+        expect(response).toBeDefined();
+        expect(response.status).toEqual(200);
+        const { result } = response || {};
+        expect(result.id).toBe(gatewayId);
+        expect(result.name).toEqual(gwName);
+        expect(result.authentication_key.crn).toEqual(config.AUTHENTICATION_KEY);
+        expect(result.type).toEqual('connect');
+        expect(result.speed_mbps).toEqual(speedMbps);
+        expect(result.bgp_asn).toEqual(params.bgpAsn);
+        expect(result.operational_status).toEqual('create_pending');
+        expect(result.provider_api_managed).toBeTruthy();
+        expect(result.bgp_cer_cidr).not.toBe('');
+        expect(result.bgp_ibm_cidr).not.toBe('');
+        expect(result.bgp_ibm_asn).not.toBe('');
+        expect(result.bgp_status).not.toBe('');
+        expect(result.created_at).not.toBe('');
+        expect(result.port.id).toBe(portId);
+        expect(result.global).toBeFalsy();
+        expect(result.metered).toBeFalsy();
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+
+    it('should successfully wait for the gateway to move to provisioned state', async done => {
+      try {
+        const result = await poll(
+          () => dlProviderService.getProviderGateway({ id: gatewayId }),
+          result => result.operational_status === 'provisioned',
+          100
+        );
+
+        expect(result).toBeDefined();
+        expect(result.operational_status).toEqual('provisioned');
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+
+    it('should successfully request delete gateway using provider account', async done => {
+      try {
+        const response = await dlProviderService.deleteProviderGateway({ id: gatewayId });
+        expect(response).toBeDefined();
+        expect(response.status).toEqual(202);
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+
+    it('should successfully approve delete gayeway using client account', async done => {
+      try {
+        const response = await dlService.createGatewayAction({
+          id: gatewayId,
+          action: 'delete_gateway_approve',
+        });
+        expect(response).toBeDefined();
+        expect(response.status).toEqual(204);
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+  });
 });

test/integration/direct-link-provider.v2.test.js

@@ -539,6 +539,12 @@ describe('DirectLinkV1', () => {
     describe('positive tests', () => {
       // Request models needed by this operation.
 
+      // GatewayActionTemplateAuthenticationKey
+      const gatewayActionTemplateAuthenticationKeyModel = {
+        crn:
+          'crn:v1:staging:public:kms:us-south:a/3b1bd7fa2bc3406ea70ba4ade8aa3f1b:6f2b3d69-9e70-46e6-bcaa-f96ecc232cbc:key:4f9d186a-5cc1-4305-94fc-af183ddf65bc',
+      };
+
       // ResourceGroupIdentity
       const resourceGroupIdentityModel = {
         id: '56969d6043e9465c883cb9f7363e78e8',
@@ -548,13 +554,15 @@ describe('DirectLinkV1', () => {
         // Construct the params object for operation createGatewayAction
         const id = 'testString';
         const action = 'create_gateway_approve';
+        const authenticationKey = gatewayActionTemplateAuthenticationKeyModel;
         const global = true;
         const metered = false;
         const resourceGroup = resourceGroupIdentityModel;
         const updates = [{ foo: 'bar' }];
         const params = {
           id: id,
           action: action,
+          authenticationKey: authenticationKey,
           global: global,
           metered: metered,
           resourceGroup: resourceGroup,
@@ -576,6 +584,7 @@ describe('DirectLinkV1', () => {
         const expectedContentType = 'application/json';
         checkMediaHeaders(createRequestMock, expectedAccept, expectedContentType);
         expect(options.body['action']).toEqual(action);
+        expect(options.body['authentication_key']).toEqual(authenticationKey);
         expect(options.body['global']).toEqual(global);
         expect(options.body['metered']).toEqual(metered);
         expect(options.body['resource_group']).toEqual(resourceGroup);