Merge pull request #14 from blue-core-lod/keycloak-provider

Adds Keycloak Provider for use in React Components

Author: jermnelson

README.md

@@ -1,10 +1,4 @@
-[![CircleCI](https://circleci.com/gh/LD4P/sinopia_editor.svg?style=svg)](https://circleci.com/gh/LD4P/sinopia_editor)
-[![Test Coverage Code Climate](https://api.codeclimate.com/v1/badges/27fe0fcbf342d0bca13b/test_coverage)](https://codeclimate.com/github/LD4P/sinopia_editor/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/27fe0fcbf342d0bca13b/maintainability)](https://codeclimate.com/github/LD4P/sinopia_editor/maintainability)
-[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/ld4p/sinopia_editor?sort=semver)](https://hub.docker.com/repository/docker/ld4p/sinopia_editor/tags?page=1&ordering=last_updated)
-
-
-# Sinopia Linked Data Editor
+# Blue Core's Sinopia Linked Data Editor
 
 Technical documentation specific to the Sinopia Linked Data Editor may also be found in the [wiki](https://github.com/LD4P/sinopia_editor/wiki/Sinopia-Editor). The Sinopia Editor homepage is available [development.sinopia.io](http://development.sinopia.io), [stage.sinopia.io](https://stage.sinopia.io), and [sinopia.io](https://sinopia.io). The Sinopia Editor is a React application with all new user interfaces and functionality using React and the React ecosystem. Portions of the codebase originally extracted from the Library of Congress [bfe project](https://github.com/lcnetdev/bfe).
 

__tests__/actionCreators/authenticate.test.js

@@ -1,26 +1,13 @@
 // Copyright 2019 Stanford University see LICENSE for license
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    login: jest.fn(() => Promise.resolve(true)),
-    logout: jest.fn(() => Promise.resolve(true)),
-    authenticated: false,
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import { authenticate, signIn, signOut } from "actionCreators/authenticate"
 import configureMockStore from "redux-mock-store"
 import thunk from "redux-thunk"
 import * as sinopiaApi from "sinopiaApi"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 const mockStore = configureMockStore([thunk])
 
 const userData = {
@@ -30,28 +17,34 @@ const userData = {
 describe("authenticate", () => {
   beforeEach(() => {
     jest.clearAllMocks()
-    mockKeycloak.authenticated = false
   })
 
   describe("user already in state", () => {
     it("does not authenticate", async () => {
+      const mockKeycloak = {}
       const store = mockStore({
         authenticate: { user: { username: "havram" } },
       })
-      await store.dispatch(authenticate())
+      await store.dispatch(authenticate(mockKeycloak))
       expect(store.getActions()).toEqual([])
     })
   })
 
   describe("successful", () => {
     sinopiaApi.fetchUser = jest.fn().mockResolvedValue(userData)
     it("dispatches actions to add user", async () => {
-      mockKeycloak.authenticated = true
-      mockKeycloak.tokenParsed = {
-        preferred_username: "havram",
+      const mockKeycloak = {
+        authenticated: true,
+        isTokenExpired: jest.fn(),
+        updateToken: jest.fn(),
+        login: jest.fn(() => Promise.resolve(true)),
+        tokenParsed: {
+          preferred_username: "havram",
+        },
       }
+
       const store = mockStore({ authenticate: { user: undefined } })
-      await store.dispatch(authenticate())
+      await store.dispatch(authenticate(mockKeycloak))
 
       expect(store.getActions()).toHaveAction("SET_USER", {
         username: "havram",
@@ -62,8 +55,9 @@ describe("authenticate", () => {
   })
   describe("failure", () => {
     it("dispatches actions to remove user", async () => {
+      const mockKeycloak = { authenticated: false }
       const store = mockStore({ authenticate: { user: undefined } })
-      await store.dispatch(authenticate())
+      await store.dispatch(authenticate(mockKeycloak))
       expect(store.getActions()).toHaveAction("REMOVE_USER")
     })
   })
@@ -72,21 +66,25 @@ describe("authenticate", () => {
 describe("signIn", () => {
   beforeEach(() => {
     jest.clearAllMocks()
-    mockKeycloak.authenticated = false
   })
 
   describe("successful", () => {
     sinopiaApi.fetchUser = jest.fn().mockResolvedValue(userData)
     it("dispatches actions to add user", async () => {
       let store = mockStore()
-      await store.dispatch(signIn("havram", "m&rc", "testerrorkey"))
+      const mockKeycloak = {
+        login: jest.fn(() => Promise.resolve(true)),
+        isTokenExpired: jest.fn(),
+        updateToken: jest.fn(),
+      }
+      await store.dispatch(signIn(mockKeycloak, "testerrorkey"))
       // After successful signIn, redirected to Sinopia home-page
       mockKeycloak.authenticated = true
       mockKeycloak.tokenParsed = {
         preferred_username: "havram",
       }
       store = mockStore({ authenticate: { user: undefined } })
-      await store.dispatch(authenticate())
+      await store.dispatch(authenticate(mockKeycloak))
 
       expect(store.getActions()).toHaveAction("SET_USER", {
         username: "havram",
@@ -98,13 +96,16 @@ describe("signIn", () => {
   describe("failure", () => {
     it("dispatches actions to remove user", async () => {
       let store = mockStore()
-      await store.dispatch(signIn("mdewey", "amh&rst", "testerrorkey"))
+      const mockKeycloak = {
+        login: jest.fn(() => Promise.resolve(false)),
+      }
+      await store.dispatch(signIn(mockKeycloak, "testerrorkey"))
       expect(store.getActions()).toHaveAction("CLEAR_ERRORS", "testerrorkey")
 
       // SignIn failures happen in Keycloak so can't test failures
       // directly, simulates user refreshing Sinopia
       store = mockStore({ authenticate: { user: undefined } })
-      await store.dispatch(authenticate())
+      await store.dispatch(authenticate(mockKeycloak))
 
       expect(store.getActions()).toHaveAction("REMOVE_USER")
     })
@@ -115,7 +116,10 @@ describe("signOut", () => {
   describe("successful", () => {
     it("dispatches actions to remove user", async () => {
       const store = mockStore()
-      await store.dispatch(signOut())
+      const mockKeycloak = {
+        logout: jest.fn(() => Promise.resolve(true)),
+      }
+      await store.dispatch(signOut(mockKeycloak))
 
       expect(store.getActions()).toHaveAction("REMOVE_USER")
     })

__tests__/actionCreators/relationships.test.js

@@ -1,22 +1,3 @@
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import {
   loadRelationships,
   loadSearchRelationships,
@@ -26,6 +7,10 @@ import configureMockStore from "redux-mock-store"
 import thunk from "redux-thunk"
 import { createState } from "stateUtils"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 const mockStore = configureMockStore([thunk])
 
 const relationships = {

__tests__/actionCreators/resources.loadResource.test.js

@@ -1,22 +1,3 @@
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import {
   loadResourceForEditor,
   loadResourceForPreview,
@@ -35,6 +16,10 @@ import expectedAction from "../__action_fixtures__/loadResource-ADD_SUBJECT"
 import expectedMultiplePropertyUrisAction from "../__action_fixtures__/loadResource-ADD_SUBJECT-multiple-property-uris"
 import { safeAction, cloneAddResourceActionAsNewResource } from "actionUtils"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 jest.useFakeTimers({ now: new Date("2020-08-20T11:34:40.887Z") })
 jest.mock("nanoid")
 

__tests__/actionCreators/resources.newResource.test.js

@@ -1,22 +1,3 @@
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import { newResource } from "actionCreators/resources"
 import mockConsole from "jest-mock-console"
 import * as sinopiaApi from "sinopiaApi"
@@ -28,6 +9,10 @@ import { nanoid } from "nanoid"
 import { safeAction } from "actionUtils"
 import expectedAction from "../__action_fixtures__/newResource-ADD_SUBJECT"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 jest.useFakeTimers({ now: new Date("2020-08-20T11:34:40.887Z") })
 jest.mock("nanoid")
 

__tests__/actionCreators/resources.newResourceCopy.test.js

@@ -1,22 +1,3 @@
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import { newResourceCopy } from "actionCreators/resources"
 import mockConsole from "jest-mock-console"
 import Config from "Config"
@@ -27,6 +8,10 @@ import { nanoid } from "nanoid"
 import expectedAction from "../__action_fixtures__/newResourceCopy-ADD_SUBJECT"
 import { safeAction } from "actionUtils"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 // This won't be required after Jest 27
 jest.useFakeTimers({ now: new Date("2020-08-20T11:34:40.887Z") })
 jest.mock("nanoid")

__tests__/actionCreators/resources.newResourceFromDataset.test.js

@@ -1,22 +1,3 @@
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import { newResourceFromDataset } from "actionCreators/resources"
 import mockConsole from "jest-mock-console"
 import Config from "Config"
@@ -32,6 +13,10 @@ import expectedBadOrderedAction from "../__action_fixtures__/newResourceFromData
 import expectedNestedAction from "../__action_fixtures__/newResourceFromDataset-ADD_SUBJECT-nested"
 import { safeAction, cloneAddResourceActionAsNewResource } from "actionUtils"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 jest.mock("nanoid")
 
 nanoid.mockImplementation(() => "abc123")

__tests__/actionCreators/resources.test.js

@@ -1,22 +1,3 @@
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import {
   expandProperty,
   addSiblingValueSubject,
@@ -38,6 +19,10 @@ import expectedExpandPropertyAddValueAction from "../__action_fixtures__/expandP
 import expectedExpandPropertyAddPropertyAction from "../__action_fixtures__/expandProperty-ADD_PROPERTY"
 import expectedAddSiblingAddValueAction from "../__action_fixtures__/addSiblingValueSubject-ADD_VALUE"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 jest.useFakeTimers({ now: new Date("2020-08-20T11:34:40.887Z") })
 jest.mock("nanoid")
 

__tests__/actionCreators/search.test.js

@@ -1,23 +1,4 @@
 // Copyright 2019 Stanford University see LICENSE for license
-let mockKeycloak
-
-jest.mock("keycloak-js", () => {
-  mockKeycloak = {
-    init: jest.fn(() => Promise.resolve(true)),
-    token: "Secret-Token",
-    authenticated: true,
-    isTokenExpired: jest.fn(),
-    updateToken: jest.fn(),
-    tokenParsed: {
-      preferred_username: "Foo McBar",
-    },
-  }
-
-  return jest.fn().mockImplementation((config) => {
-    return mockKeycloak
-  })
-})
-
 import {
   fetchSinopiaSearchResults,
   fetchQASearchResults,
@@ -30,6 +11,10 @@ import { createState } from "stateUtils"
 import * as sinopiaApi from "sinopiaApi"
 import * as QuestioningAuthority from "utilities/QuestioningAuthority"
 
+jest.mock("KeycloakContext", () => ({
+  useKeycloak: jest.fn().mockReturnValue({}),
+}))
+
 const mockStore = configureMockStore([thunk])
 
 describe("fetchSinopiaSearchResults", () => {