Chat proof

README.md

@@ -70,7 +70,8 @@ When you want to test the component within a solid-pane, you can use the [develo
 
 ## Adding Tests
 
-Need to point to Unit test Readme.
+The following document gives guidance on how to add and perform testing in solid-ui.
+[Testing in solid-ui](https://github.com/SolidOS/solid-ui/blob/18070a02fa8159a2b83d9503ee400f8e046bf1f6/test/unit/README.md)
 
 ## Further documentation
 

src/chat/keys.ts

@@ -16,6 +16,13 @@ export function generatePublicKey (privateKey: string): string {
   return bytesToHex(schnorr.getPublicKey(privateKey))
 }
 
+/**
+ * getPublicKey
+ * used for displaying messages in chat, therefore does not
+ * create a new key if not found
+ * @param webId
+ * @returns string | undefined
+ */
 export async function getPublicKey (webId: NamedNode) {
   await store.fetcher.load(webId)
   const publicKeyDoc = await pubKeyUrl(webId)
@@ -26,9 +33,6 @@ export async function getPublicKey (webId: NamedNode) {
   } catch (err) {
     return undefined
   }
-  // this is called in display message and should not try to create a publicKeyDoc
-  // const publicKey = await publicKeyExists(webId)
-  // return publicKey
 }
 
 export async function getPrivateKey (webId: NamedNode) {

test/unit/README.md

@@ -1,10 +1,40 @@
 # Solid-UI Unit Testing
+The purpose of this README is to provide guidance on how to write tests for solid-ui for beginners.
 
+Although we would love to have 100% test coverage, we realize that this is not a commericial product. solid-ui is an open source, volunteer built library that houses UI components that can be used to build Solid applications. We are working to increase test coverage on existing code, any help is much appreciated. If you add a new component to solid-ui, you should write tests to test the main functionality of your component in order for your PR to be merged.
 
 ## Running Tests
 
+### All
+The following command will run all the tests.
+`npm run test`
+
+### One file at a time
+There are a lot of tests in `solid-ui` so you will most likely want to run only the test you are working on at the moment. In order to do that you can use the following command.
+`npm test <filetobetested>`
+`npm test test/unit/utils/keyHelpers/accessData.test.ts`
+
+### Coverage
+Run the following command:
+`npm run coverage`
+
+Then you can see the results in `coverage/lcov-report/index.html`. If you are using VSCode you can right click and select to `Open in Browser Preview`. Otherwise, you can type the path in your browswer, for instance `file:///Users/<yourhomedirectory>/2023Development/solid-ui/coverage/lcov-report/index.html` is an example.
 
 ## Tips and Tricks
+The following are some tips and tricks in hopes to make testing easier.
+
+### VSCode Debugging
+There is an extension that can be used to aide in debugging jest tests. To find out more about it you can look at [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner)
+
+### Mocking
+In solid-ui we do not currently follow a MVC pattern therefore there can be some difficulty in testing. The following are patterns to help with this.
+#### Store methods
+##### Load
+In SolidOS we use [rdflib.js](https://github.com/linkeddata/rdflib.js/) to work with LinkedData. The way this works is that you first load the document you need to work with into the store. Once the document is loaded you can then access the data by using additional methods on the store such as `any, each,...`. Since the data that gets returned will need to be mocked, `load` doesn't need to do anything. See below for what you need to put in the top of your file in order to mock the `load` method.  
+`import { store } from 'solid-logic'` at the top of your file.
+
+`store.fetcher.load = jest.fn().mockImplementation(() => {})`
 
-### Mock the fetcher
+##### Any
 
+##### Each

test/unit/chat/keys.test.ts

@@ -1,19 +1,13 @@
-import { error, log, trace, warn } from '../../src/debug'
 import { generatePrivateKey, generatePublicKey, getPublicKey } from '../../../src/chat/keys'
-import Fetcher from 'rdflib/lib/fetcher'
-import { solidLogicSingleton } from 'solid-logic'
-// import * as helpers from '../../../src/utils/cryptoKeyHelpers'
+import { store } from 'solid-logic'
+import { NamedNode } from 'rdflib'
+import * as helpers from '../../../src/utils/keyHelpers/accessData'
 const PRIV_KEY = 'a11bc5d2eee6cdb3b37f5473a712cad905ccfb13fb2ccdbf1be0a1ac4fdc7d2a'
 const PUB_KEY = '023a9da707bee1302f66083c9d95673ff969b41607a66f52686fa774d64ceb87'
 
-const store = solidLogicSingleton
-// jest.mock('../../../src/utils/cryptoKeyHelpers')
-
-// @ts-ignore
-// store.fetcher.load = jest.fn().mockImplementation(() => {}) as unknown as Fetcher
-
-// @ts-ignore
-// jest.spyOn('helpers', 'pubKeyUrl').mockImplementation(() => 'test')
+jest.mock('../../../src/utils/keyHelpers/accessData')
+store.fetcher.load = jest.fn().mockImplementation(() => {})
+store.any = jest.fn()
 
 describe('generate key pair', () => {
   // console.log('alain')
@@ -29,7 +23,20 @@ describe('generate key pair', () => {
 })
 
 describe('getPublicKey', () => {
-  it.skip('should do something', async () => {
-    expect(await getPublicKey('https://sstratsianis.solidcommunity.net/profile/card#me')).toThrowError()
+  const webId = new NamedNode('https://alice.solidcommunity.net/profile/card#me')
+  it('should return the key', async () => {
+    /* @ts-ignore */
+    jest.spyOn(helpers, 'pubKeyUrl').mockResolvedValue('https://alice.solidcommunity.net/profile/keys/publicKey.ttl')
+    /* @ts-ignore */
+    store.any.mockReturnValue({ value: PUB_KEY })
+    const webId = new NamedNode('https://alice.solidcommunity.net/profile/card#me')
+    const result = await getPublicKey(webId)
+    expect(result).toBe(PUB_KEY)
+  })
+  it.skip('should return undefined if loading and retrieving key fails', async () => {
+    jest.spyOn(helpers, 'pubKeyUrl').mockResolvedValue('https://alice.solidcommunity.net/profile/keys/publicKey.ttl')
+    /* @ts-ignore */
+    store.any.mockRejectedValue()
+    expect(await getPublicKey(webId)).rejects.toThrowError()
   })
 })

test/unit/utils/keyHelpers/acl.test.ts

@@ -1,6 +1,18 @@
-describe('acl Helpers', () => {
-  describe.skip('setAcl', () => {
-    it.skip('not sure yet', () => {
+import { store } from 'solid-logic'
+import { setAcl, keyAclBody } from '../../../../src/utils/keyHelpers/acl'
+
+store.fetcher.load = jest.fn().mockImplementation(() => {})
+store.any = jest.fn()
+
+describe('ACL Helpers', () => {
+  describe('setAcl', () => {
+    it('throws an error if an ACL document is NOT found', async () => {
+      /* @ts-ignore */
+      store.any.mockReturnValue('')
+      const keyDoc = 'https://alice.solidcommunity.net/profile/keys/publicKey.ttl'
+      await expect(setAcl(keyDoc, keyAclBody(keyDoc, ''))).rejects.toThrowError('Key ACL doc not found!')
+    })
+    it.skip('want to find out why we delete and then re-add', () => {
 
     })
   })