test: add specs for custom dictionary API (electron#22158)

erickzhao · web-flow · commit 01c597a64681 · 2020-03-02T16:57:46.000-08:00
* tests

* test: add specs for custom dictionary API

* await
diff --git a/spec-main/spellchecker-spec.ts b/spec-main/spellchecker-spec.ts
@@ -1,4 +1,4 @@
-import { BrowserWindow } from 'electron'
+import { BrowserWindow, Session, session } from 'electron'
 
 import { expect } from 'chai'
 import * as path from 'path'
@@ -53,4 +53,70 @@ describe('spellchecker', () => {
     expect(contextMenuParams.misspelledWord).to.eq('Beautifulllll')
     expect(contextMenuParams.dictionarySuggestions).to.have.length.of.at.least(1)
   })
+
+  describe('custom dictionary word list API', () => {
+    let ses: Session
+
+    beforeEach(async () => {
+      // ensure a new session runs on each test run
+      ses = session.fromPartition(`persist:customdictionary-test-${Date.now()}`)
+    })
+
+    afterEach(async () => {
+      if (ses) {
+        await ses.clearStorageData()
+        ses.destroy()
+      }
+    })
+
+    describe('ses.listWordsFromSpellCheckerDictionary', () => {
+      it('should successfully list words in custom dictionary', async () => {
+        const words = ['foo', 'bar', 'baz']
+        const results = words.map(word => ses.addWordToSpellCheckerDictionary(word))
+        expect(results).to.eql([true, true, true])
+
+        const wordList = await ses.listWordsInSpellCheckerDictionary()
+        expect(wordList).to.have.deep.members(words)
+      })
+
+      it('should return an empty array if no words are added', async () => {
+        const wordList = await ses.listWordsInSpellCheckerDictionary()
+        expect(wordList).to.have.length(0)
+      })
+    })
+
+    describe('ses.addWordToSpellCheckerDictionary', () => {
+      it('should successfully add word to custom dictionary', async () => {
+        const result = ses.addWordToSpellCheckerDictionary('foobar')
+        expect(result).to.equal(true)
+        const wordList = await ses.listWordsInSpellCheckerDictionary()
+        expect(wordList).to.eql(['foobar'])
+      })
+
+      it('should fail for an empty string', async () => {
+        const result = ses.addWordToSpellCheckerDictionary('')
+        expect(result).to.equal(false)
+        const wordList = await ses.listWordsInSpellCheckerDictionary
+        expect(wordList).to.have.length(0)
+      })
+    })
+
+    describe('ses.removeWordFromSpellCheckerDictionary', () => {
+      it('should successfully remove words to custom dictionary', async () => {
+        const result1 = ses.addWordToSpellCheckerDictionary('foobar')
+        expect(result1).to.equal(true)
+        const wordList1 = await ses.listWordsInSpellCheckerDictionary()
+        expect(wordList1).to.eql(['foobar'])
+        const result2 = ses.removeWordFromSpellCheckerDictionary('foobar')
+        expect(result2).to.equal(true)
+        const wordList2 = await ses.listWordsInSpellCheckerDictionary()
+        expect(wordList2).to.have.length(0)
+      })
+
+      it('should fail for words not in custom dictionary', () => {
+        const result2 = ses.removeWordFromSpellCheckerDictionary('foobar')
+        expect(result2).to.equal(false)
+      })
+    })
+  })
 })
