@adobe/aio-lib-web/test/src/deploy-web.test.js

Utility tooling library to build and deploy Adobe I/O Project Firefly app static sites to CDN

/*
Copyright 2020 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/

const { vol } = global.mockFs()
const deployWeb = require('../../src/deploy-web')
const fs = require('fs-extra')
jest.mock('fs-extra')

jest.mock('../../lib/getS3Creds')
const getS3Credentials = require('../../lib/getS3Creds')
getS3Credentials.mockResolvedValue('fakecreds')

const mockRemoteStorageInstance = {
  emptyFolder: jest.fn(),
  folderExists: jest.fn(),
  uploadDir: jest.fn()
}
const RemoteStorage = require('../../lib/remote-storage')
jest.mock('../../lib/remote-storage', () => {
  return jest.fn().mockImplementation(() => {
    return mockRemoteStorageInstance
  })
})

describe('deploy-web', () => {
  beforeEach(() => {
    RemoteStorage.mockClear()
    mockRemoteStorageInstance.emptyFolder.mockReset()
    mockRemoteStorageInstance.folderExists.mockReset()
    mockRemoteStorageInstance.uploadDir.mockReset()
    getS3Credentials.mockClear()

    global.cleanFs(vol)
  })

  test('throws if config does not have an app, or frontEnd', async () => {
    await expect(deployWeb()).rejects.toThrow('cannot deploy web')
    await expect(deployWeb({ app: 'nothing-here' })).rejects.toThrow('cannot deploy web')
    await expect(deployWeb({ app: { hasFrontEnd: false } })).rejects.toThrow('cannot deploy web')
  })

  test('throws if src dir does not exist', async () => {
    const config = {
      s3: {
        creds: 'not-null'
      },
      app: {
        hasFrontend: true
      },
      web: {
        distProd: 'dist'
      }
    }
    await expect(deployWeb(config)).rejects.toThrow('missing files in dist')
  })

  test('throws if src dir is not a directory', async () => {
    const config = {
      s3: {
        creds: 'not-null'
      },
      app: {
        hasFrontend: true
      },
      web: {
        distProd: 'dist'
      }
    }
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => false })
    await expect(deployWeb(config)).rejects.toThrow('missing files in dist')
  })

  test('throws if src dir is empty', async () => {
    const config = {
      s3: {
        creds: 'not-null'
      },
      app: {
        hasFrontend: true
      },
      web: {
        distProd: 'dist'
      }
    }
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => true })
    fs.readdirSync.mockReturnValue({ length: 0 })
    await expect(deployWeb(config)).rejects.toThrow('missing files in dist')
  })

  test('uploads files', async () => {
    const config = {
      ow: {
        namespace: 'ns',
        auth: 'password'
      },
      s3: {
        credsCacheFile: 'file',
        tvmUrl: 'url',
        folder: 'somefolder'
      },
      app: {
        hasFrontend: true,
        hostname: 'host'
      },
      web: {
        distProd: 'dist'
      }
    }
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => true })
    fs.readdirSync.mockReturnValue({ length: 1 })
    await expect(deployWeb(config)).resolves.toEqual('https://ns.host/index.html')
    expect(getS3Credentials).toHaveBeenCalledWith(config)
    expect(RemoteStorage).toHaveBeenCalledWith('fakecreds')
    expect(mockRemoteStorageInstance.uploadDir).toHaveBeenCalledWith('dist', 'somefolder', config, null)
    expect(mockRemoteStorageInstance.emptyFolder).not.toHaveBeenCalled()
    expect(mockRemoteStorageInstance.folderExists).toHaveBeenCalledWith('somefolder/')
  })

  test('uploads files with log func', async () => {
    const config = {
      ow: {
        namespace: 'ns',
        auth: 'password'
      },
      s3: {
        credsCacheFile: 'file',
        tvmUrl: 'url',
        folder: 'somefolder'
      },
      app: {
        hasFrontend: true,
        hostname: 'host'
      },
      web: {
        distProd: 'dist'
      }
    }
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => true })
    fs.readdirSync.mockReturnValue({ length: 1 })
    const mockLogger = jest.fn()
    // for func coverage
    mockRemoteStorageInstance.uploadDir.mockImplementation((a, b, c, func) => func('somefile'))
    await expect(deployWeb(config, mockLogger)).resolves.toEqual('https://ns.host/index.html')
    expect(getS3Credentials).toHaveBeenCalledWith(config)
    expect(RemoteStorage).toHaveBeenCalledWith('fakecreds')
    expect(mockRemoteStorageInstance.uploadDir).toHaveBeenCalledWith('dist', 'somefolder', config, expect.any(Function))
    expect(mockRemoteStorageInstance.emptyFolder).not.toHaveBeenCalled()
    expect(mockRemoteStorageInstance.folderExists).toHaveBeenCalledWith('somefolder/')
  })

  test('overwrites remote files', async () => {
    const config = {
      ow: {
        namespace: 'ns',
        auth: 'password'
      },
      s3: {
        creds: 'somecreds',
        folder: 'somefolder'
      },
      app: {
        hasFrontend: true,
        hostname: 'host'
      },
      web: {
        distProd: 'dist'
      }
    }
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => true })
    const mockLogger = jest.fn()
    fs.readdirSync.mockReturnValue({ length: 1 })

    mockRemoteStorageInstance.folderExists.mockResolvedValue(true)

    await expect(deployWeb(config, mockLogger)).resolves.toEqual('https://ns.host/index.html')
    expect(getS3Credentials).toHaveBeenCalledWith(config)
    expect(mockLogger).toHaveBeenCalledWith('warning: an existing deployment will be overwritten')
    expect(RemoteStorage).toHaveBeenCalledWith('fakecreds')
    expect(mockRemoteStorageInstance.folderExists).toHaveBeenCalledWith('somefolder/')
    expect(mockRemoteStorageInstance.uploadDir).toHaveBeenCalledWith('dist', 'somefolder', config, expect.any(Function))
    // empty dir!
    expect(mockRemoteStorageInstance.emptyFolder).toHaveBeenCalledWith('somefolder/')
  })

  test('overwrites remote files no log func', async () => {
    const config = {
      ow: {
        namespace: 'ns',
        auth: 'password'
      },
      s3: {
        folder: 'somefolder'
      },
      app: {
        hasFrontend: true,
        hostname: 'host'
      },
      web: {
        distProd: 'dist'
      }
    }
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => true })
    fs.readdirSync.mockReturnValue({ length: 1 })

    mockRemoteStorageInstance.folderExists.mockResolvedValue(true)

    await expect(deployWeb(config)).resolves.toEqual('https://ns.host/index.html')
    expect(getS3Credentials).toHaveBeenCalledWith(config)
    expect(mockRemoteStorageInstance.folderExists).toHaveBeenCalledWith('somefolder/')
    expect(mockRemoteStorageInstance.uploadDir).toHaveBeenCalledWith('dist', 'somefolder', config, null)
    // empty dir!
    expect(mockRemoteStorageInstance.emptyFolder).toHaveBeenCalledWith('somefolder/')
  })

  test('calls to s3 should use ending slash', async () => {
    const config = {
      ow: {
        namespace: 'ns',
        auth: 'password'
      },
      s3: {
        credsCacheFile: 'file',
        tvmUrl: 'url',
        folder: 'nsfolder'
      },
      app: {
        hasFrontend: true,
        hostname: 'host'
      },
      web: {
        distProd: 'dist'
      }
    }
    const emptyFolder = jest.fn()
    const folderExists = jest.fn(() => true)
    RemoteStorage.mockImplementation(() => {
      return {
        emptyFolder,
        folderExists,
        uploadDir: jest.fn()
      }
    })
    fs.existsSync.mockReturnValue(true)
    fs.lstatSync.mockReturnValue({ isDirectory: () => true })
    const mockLogger = jest.fn()
    fs.readdirSync.mockReturnValue({ length: 1 })
    await expect(deployWeb(config, mockLogger)).resolves.toEqual('https://ns.host/index.html')
    expect(getS3Credentials).toHaveBeenCalled()
    expect(RemoteStorage).toHaveBeenCalledTimes(1)
    expect(folderExists).toHaveBeenLastCalledWith('nsfolder/')
    expect(emptyFolder).toHaveBeenLastCalledWith('nsfolder/')
  })
})