jan/electron/core/plugin-manager/pluginMgr/store.test.js

import { getActivePlugins, getAllPlugins, getPlugin, installPlugins } from './store'
import { init } from "."
import { join } from 'path'
import Plugin from "./Plugin"
import { mkdirSync, writeFileSync, rmSync } from "fs"

// Temporary directory to install plugins to
const pluginsDir = './testPlugins'

// Temporary directory containing the active plugin to install
const activePluginDir = './activePluginSrc'
const activePluginName = 'active-plugin'
const activeManifest = join(activePluginDir, 'package.json')

// Temporary directory containing the inactive plugin to install
const inactivePluginDir = './inactivePluginSrc'
const inactivePluginName = 'inactive-plugin'
const inactiveManifest = join(inactivePluginDir, 'package.json')

// Mock name for the entry file in the plugins
const main = 'index'

/** @type Array.<Plugin> */
let activePlugins
/** @type Array.<Plugin> */
let inactivePlugins

beforeAll(async () => {
  // Initialize pluggable Electron
  init({
    confirmInstall: () => true,
    pluginsPath: pluginsDir,
  })

  // Create active plugin
  mkdirSync(activePluginDir)
  writeFileSync(activeManifest, JSON.stringify({
    name: activePluginName,
    activationPoints: [],
    main,
  }), 'utf8')

  // Create active plugin
  mkdirSync(inactivePluginDir)
  writeFileSync(inactiveManifest, JSON.stringify({
    name: inactivePluginName,
    activationPoints: [],
    main,
  }), 'utf8')

  // Install plugins
  activePlugins = await installPlugins([activePluginDir], true)
  activePlugins[0].setActive(true)
  inactivePlugins = await installPlugins([{
    specifier: inactivePluginDir,
    activate: false
  }], true)
})

afterAll(() => {
  // Remove all test files and folders
  rmSync(pluginsDir, { recursive: true })
  rmSync(activePluginDir, { recursive: true })
  rmSync(inactivePluginDir, { recursive: true })
})

describe('installPlugins', () => {
  it('should create a new plugin found at the given location and return it if store is false', async () => {
    const res = await installPlugins([activePluginDir], false)

    expect(res[0]).toBeInstanceOf(Plugin)
  })

  it('should create a new plugin found at the given location and register it if store is true', () => {
    expect(activePlugins[0]).toBeInstanceOf(Plugin)
    expect(getPlugin(activePluginName)).toBe(activePlugins[0])
  })

  it('should activate the installed plugin by default', () => {
    expect(getPlugin(activePluginName).active).toBe(true)
  })

  it('should set plugin to inactive if activate is set to false in the install options', async () => {
    expect(inactivePlugins[0].active).toBe(false)
  })
})

describe('getPlugin', () => {
  it('should return the plugin with the given name if it is registered', () => {
    expect(getPlugin(activePluginName)).toBeInstanceOf(Plugin)
  })

  it('should return an error if the plugin with the given name is not registered', () => {
    expect(() => getPlugin('wrongName')).toThrowError('Plugin wrongName does not exist')
  })
})

describe('getAllPlugins', () => {
  it('should return a list of all registered plugins', () => {
    expect(getAllPlugins()).toEqual([activePlugins[0], inactivePlugins[0]])
  })
})

describe('getActivePlugins', () => {
  it('should return a list of all and only the registered plugins that are active', () => {
    expect(getActivePlugins()).toEqual(activePlugins)
  })
})