configuru/src/test/storage.test.ts

Manage the configuration of your Nodejs application with multiple environments and custom preferences, utilizing Configuru in CI and development as well!

/* eslint-disable sonarjs/no-duplicate-string */
import { resolve } from 'path'
import { createConfigStorage } from '../lib/storage'

describe('storage', () => {
  test('Empty', () => {
    expect(createConfigStorage({})).toEqual({})
  })
  test('Non-existent file throws error', () => {
    expect(() =>
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/dayum'),
      })
    ).toThrow(/exist/)
  })
  test('Non-valid file throws error', () => {
    expect(() =>
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/invalid'),
      })
    ).toThrow(/valid/)
  })
  test('Extension not required', () => {
    const def = createConfigStorage({
      defaultConfigPath: resolve(__dirname, './sandbox/default'),
    })
    const defJson = createConfigStorage({
      defaultConfigPath: resolve(__dirname, './sandbox/default.json'),
    })
    const defJsonc = createConfigStorage({
      defaultConfigPath: resolve(__dirname, './sandbox/default.jsonc'),
    })
    expect(def).toStrictEqual(defJson)
    expect(defJson).toStrictEqual(defJsonc)
  })
  test('Default', () => {
    expect(
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/default.json'),
      })
    ).toMatchInlineSnapshot(`
            Object {
              "bar": 1,
              "baz": 2,
              "defaultConfig": true,
              "foo": "default",
            }
        `)
  })
  test('Default (jsonc)', () => {
    expect(
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/default.jsonc'),
      })
    ).toMatchInlineSnapshot(`
            Object {
              "bar": 1,
              "baz": 2,
              "defaultConfig": true,
              "foo": "default",
            }
        `)
  })
  test('Default & user', () => {
    expect(
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/default.json'),
        userConfigPath: resolve(__dirname, './sandbox/user.json'),
      })
    ).toMatchInlineSnapshot(`
            Object {
              "bar": 1,
              "baz": 2,
              "defaultConfig": true,
              "foo": "user",
              "quix": false,
              "userConfig": true,
            }
        `)
  })
  test('Default & user & env', () => {
    process.env.foo = 'env'
    process.env.bar = '3'
    expect(
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/default.json'),
        userConfigPath: resolve(__dirname, './sandbox/user.json'),
        envMode: 'default',
      })
    ).toMatchInlineSnapshot(`
                Object {
                  "bar": "3",
                  "baz": 2,
                  "defaultConfig": true,
                  "foo": "env",
                  "quix": false,
                  "userConfig": true,
                }
            `)
  })
  test('Default configuration can be inline', () => {
    expect(
      createConfigStorage({
        defaultConfigPath: JSON.stringify({
          inlinesecret: 'secret',
        }),
      })
    ).toMatchInlineSnapshot(`
      Object {
        "inlinesecret": "secret",
      }
    `)
  })
  test('User configuration can be inline', () => {
    expect(
      createConfigStorage({
        defaultConfigPath: resolve(__dirname, './sandbox/default.json'),
        userConfigPath: JSON.stringify({
          bar: 'inline',
          inlinesecret: 'secret',
        }),
      })
    ).toMatchInlineSnapshot(`
      Object {
        "bar": "inline",
        "baz": 2,
        "defaultConfig": true,
        "foo": "default",
        "inlinesecret": "secret",
      }
    `)
  })
})