basic tests for expected cf api org responses

instructs jest to ignore mocks directory

adds interface for api org response

Author: jduss4

.env.test

@@ -7,3 +7,5 @@ UAA_AUTH_PATH=/oauth/authorize
 UAA_TOKEN_PATH=/oauth/token
 UAA_LOGOUT_PATH=/logout.do
 
+CF_API_URL=https://example.com
+CF_API_TOKEN=placeholder

__tests__/api/cloudfoundry.test.js

@@ -1,6 +1,18 @@
-import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
-import { getToken } from '../../api/cloudfoundry';
+import nock from 'nock';
 import { cookies } from 'next/headers';
+import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
+import {
+  getToken,
+  getCFOrg,
+  getCFOrgUsers,
+  getCFOrgs,
+} from '../../api/cloudfoundry';
+import {
+  mockOrg,
+  mockOrgNotFound,
+  mockOrgUsers,
+  mockOrgs,
+} from './mocks/organizations';
 
 /* global jest */
 /* eslint no-undef: "off" */
@@ -10,6 +22,54 @@ jest.mock('next/headers', () => ({
 /* eslint no-undef: "error" */
 
 describe('cloudfoundry tests', () => {
+  describe('getCFOrg', () => {
+    it('when given a valid org guid, returns a single org', async () => {
+      nock(process.env.CF_API_URL)
+        .get('/organizations/validGUID')
+        .reply(200, mockOrg);
+      const res = await getCFOrg('validGUID');
+      expect(res).toEqual(mockOrg);
+    });
+
+    it('when given an invalid or unauthorized org guid, throws an error', async () => {
+      nock(process.env.CF_API_URL)
+        .get('/organizations/invalidGUID')
+        .reply(404, mockOrgNotFound);
+
+      expect(async () => {
+        await getCFOrg('invalidGUID');
+      }).rejects.toThrow(new Error('an error occurred with response code 404'));
+    });
+  });
+
+  describe('getCFOrgUsers', () => {
+    it('when given a valid org guid, returns associated users', async () => {
+      nock(process.env.CF_API_URL)
+        .get('/organizations/validGUID/users')
+        .reply(200, mockOrgUsers);
+      const res = await getCFOrgUsers('validGUID');
+      expect(res).toEqual(mockOrgUsers.resources);
+    });
+
+    it('when given an invalid or unauthorized org guid, throws an error', async () => {
+      nock(process.env.CF_API_URL)
+        .get('/organizations/invalidGUID/users')
+        .reply(404, mockOrgNotFound);
+
+      expect(async () => {
+        await getCFOrgUsers('invalidGUID');
+      }).rejects.toThrow(new Error('an error occurred with response code 404'));
+    });
+  });
+
+  describe('get CFOrgs', () => {
+    it('returns orgs available to the user', async () => {
+      nock(process.env.CF_API_URL).get('/organizations').reply(200, mockOrgs);
+      const res = await getCFOrgs();
+      expect(res).toEqual(mockOrgs.resources);
+    });
+  });
+
   describe('getToken', () => {
     describe('when token environment variable is set', () => {
       beforeEach(() => {

__tests__/api/mocks/organizations.js

@@ -32,6 +32,17 @@ export const mockOrg = {
   },
 };
 
+// /v3/organizations/[bad-guid]
+export const mockOrgNotFound = {
+  errors: [
+    {
+      detail: 'Organization not found',
+      title: 'CF-ResourceNotFound',
+      code: 10010,
+    },
+  ],
+};
+
 // /v3/organizations/[guid]/users
 export const mockOrgUsers = {
   pagination: {

api/cloudfoundry.ts

@@ -18,15 +18,28 @@ export async function getCFResources(resourcePath: string) {
     } else {
       throw new Error('resources not found');
     }
-  } catch (error) {
+  } catch (error: any) {
     throw new Error(error.message);
   }
 }
 export async function getCFApps() {
   return getCFResources('/apps');
 }
 
-export async function getCFOrg(guid: string) {
+interface CfOrg {
+  guid: string;
+  created_at: string;
+  updated_at: string;
+  name: string;
+  suspended: boolean;
+  // relationships, metadata, and links are all objects, but as we
+  // do not rely on them existing yet, they are not defined in the interface
+  relationships: any;
+  metadata: any;
+  links: any;
+}
+
+export async function getCFOrg(guid: string): Promise<CfOrg> {
   try {
     const body = await getData(CF_API_URL + '/organizations/' + guid, {
       headers: {
@@ -36,9 +49,9 @@ export async function getCFOrg(guid: string) {
     if (body) {
       return body;
     } else {
-      throw new Error('resources not found');
+      throw new Error('resource not found');
     }
-  } catch (error) {
+  } catch (error: any) {
     throw new Error(error.message);
   }
 }
@@ -62,7 +75,7 @@ export function getCFToken(): string {
   if (authSession === undefined) throw new Error();
   try {
     return JSON.parse(authSession.value).accessToken;
-  } catch (error) {
+  } catch (error: any) {
     throw new Error('accessToken not found, please confirm you are logged in');
   }
 }

app/cloudfoundry/orgs/[guid]/page.tsx

@@ -20,7 +20,6 @@ export default async function OrgPage({
           <li>Suspended: {org.suspended}</li>
           <li>Created: {org.created_at}</li>
         </ul>
-        {/* <div>{JSON.stringify(org)}</div> */}
 
         <h2>Org members</h2>
         <ul>
@@ -32,7 +31,7 @@ export default async function OrgPage({
         </ul>
       </>
     );
-  } catch (error) {
+  } catch (error: any) {
     return <div>{error.message}</div>;
   }
 }

app/cloudfoundry/orgs/page.tsx

@@ -17,7 +17,7 @@ export default async function CloudFoundryOrgsPage() {
         </ul>
       </>
     );
-  } catch (error) {
+  } catch (error: any) {
     return <div role="alert">{error.message}</div>;
   }
 }

jest.config.js

@@ -13,6 +13,7 @@ const config = {
   testEnvironment: 'node',
   // Add more setup options before each test is run
   setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
+  testPathIgnorePatterns: ['<rootDir>/__tests__/api/mocks'],
 };
 
 // createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async

public/js/uswds/uswds.min.js

@@ -22,8 +22,7 @@
       {
         "name": "next"
       }
-    ],
-    "useUnknownInCatchVariables": false
+    ]
   },
   "include": [
     "next-env.d.ts",