Jas config api for client-js (#96)

Author: barv-jfrog

.github/workflows/cla.yml

@@ -19,7 +19,7 @@ jobs:
       - name: "CLA Assistant"
         if: ${{ steps.sign-or-recheck.outputs.match != '' || github.event_name == 'pull_request_target' }}
         # Alpha Release
-        uses: cla-assistant/github-action@v2.1.1-beta
+        uses: cla-assistant/github-action@v2.6.0
         env:
           # Generated and maintained by github
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -31,6 +31,7 @@ Add jfrog-client-js as a dependency to your package.json file:
   - [Scanning a Dependency Tree with Consideration to the JFrog Project](#scanning-a-dependency-tree-with-consideration-to-the-jfrog-project)
   - [Scanning a Dependency Tree with Consideration to the Xray Watches](#scanning-a-dependency-tree-with-consideration-to-the-xray-watches)
   - [Retrieving Xray Build Details](#retrieving-xray-build-details)
+  - [Retrieving JAS configuration](#retrieving-jas-configuration)
 - [Artifactory](#artifactory)
   - [Pinging Artifactory](#pinging-artifactory)
   - [Getting Artifactory Version](#getting-artifactory-version)
@@ -199,6 +200,20 @@ jfrogClient
   });
 ```
 
+#### Retrieving JAS configuration
+```javascript
+jfrogClient
+  .xray()
+  .jasconfig()
+  .getJasConfig()      
+  .then((result) => {
+    console.log(JSON.stringify(result));
+  })
+  .catch((error) => {
+    console.error(error);
+  });
+```
+
 ### Artifactory
 
 #### Pinging Artifactory

model/Xray/JasConfig/JasConfig.ts

@@ -0,0 +1,3 @@
+export interface IJasConfig {
+    enable_token_validation_scanning: boolean;
+}

src/Xray/XrayClient.ts

@@ -7,6 +7,7 @@ import { IClientSpecificConfig } from '../../model/ClientSpecificConfig';
 import { ILogger } from '../../model/';
 import { XrayGraphClient as XrayScanClient } from '..';
 import { XrayEntitlementsClient } from './XrayEntitlementsClient';
+import { XrayJasConfigClient } from './XrayJasConfigClient';
 
 export class XrayClient {
     static readonly scanGraphEndpoint: string = 'api/v1/scan/graph';
@@ -68,4 +69,8 @@ export class XrayClient {
     public entitlements(): XrayEntitlementsClient {
         return new XrayEntitlementsClient(this.httpClient, this.logger);
     }
+
+    public jasconfig(): XrayJasConfigClient {
+        return new XrayJasConfigClient(this.httpClient, this.logger);
+    }
 }

src/Xray/XrayJasConfigClient.ts

@@ -0,0 +1,27 @@
+import { HttpClient, IRequestParams } from '../HttpClient';
+import { ILogger } from '../../model';
+import { IJasConfig } from '../../model/Xray/JasConfig/JasConfig';
+
+export class XrayJasConfigClient {
+    private readonly jasConfigurationEndpoint: string = '/api/v1/configuration/jas';
+    constructor(private readonly httpClient: HttpClient, private readonly logger: ILogger) {}
+    /**
+     *
+     * Sends 'GET /configuration/js requests to Xray and waits for 200 response'.
+     * @returns the jas config
+     * @throws an exception if an unexpected response received from Xray
+     */
+    async getJasConfig(): Promise<IJasConfig> {
+        this.logger.debug(`Sending GET ${this.jasConfigurationEndpoint} request...`);
+        const requestParams: IRequestParams = {
+            url: this.jasConfigurationEndpoint,
+            method: 'GET',
+            validateStatus: (status: number): boolean => {
+                return status === 200;
+            },
+        };
+        return await (
+          await this.httpClient.doAuthRequest(requestParams)
+        ).data;
+    }
+}

test/tests/Xray/XrayJasConfig.spec.ts

@@ -0,0 +1,32 @@
+import faker from 'faker';
+import nock from 'nock';
+import { JfrogClient } from '../../../src';
+import { TestUtils } from '../../TestUtils';
+
+describe('Xray jas config tests', () => {
+    test('Get jas config', async () => {
+        const PLATFORM_URL: string = faker.internet.url();
+        const uri: string = `/xray/api/v1/configuration/jas`;
+        const expectedResource: string = '{"enable_token_validation_scanning": true}';
+        nock(PLATFORM_URL).get(uri).reply(200, expectedResource);
+        const client: JfrogClient = new JfrogClient({ platformUrl: PLATFORM_URL, logger: TestUtils.createTestLogger() });
+        const res: any = await client.xray().jasconfig().getJasConfig();
+        expect(res).toHaveProperty("enable_token_validation_scanning")
+        expect(res.enable_token_validation_scanning).toEqual(true)
+    });
+});
+
+describe('Xray jas config tests', () => {
+    test('Fail get jas config', async () => {
+        const PLATFORM_URL: string = faker.internet.url();
+        const uri: string = `/xray/api/v1/configuration/jas`;
+        nock(PLATFORM_URL).get(uri).reply(402, { message: 'error' }).persist();
+        const client: JfrogClient = new JfrogClient({ platformUrl: PLATFORM_URL, logger: TestUtils.createTestLogger() })
+        await expect(async () => {
+            await client
+              .xray()
+              .jasconfig()
+              .getJasConfig();
+        }).rejects.toThrow(`Request failed with status code 402`);
+    });
+});

test/tests/Xray/XraySummaryClient.spec.ts

@@ -125,8 +125,8 @@ describe('Xray summary tests', () => {
 
         const license: ILicense = licenses[0];
         expect(license.name).toBe('MIT');
-        expect(license.full_name).toBe('The MIT License');
-        expect(license.more_info_url.length).toBeGreaterThanOrEqual(4);
+        expect(license.full_name).toBe('MIT License');
+        expect(license.more_info_url.length).toBeGreaterThanOrEqual(3);
         expect(license.components.length).toBe(1);
         expect(license.components[0]).toBe('npm://js-yaml:3.10.0');
     });