create-platformatic 0.46.1 → 0.47.0

package/test/service/create-service.test.mjs

@@ -1,155 +0,0 @@
-import createService from '../../src/service/create-service.mjs'
-import { isFileAccessible } from '../../src/utils.mjs'
-import { test, beforeEach, afterEach } from 'tap'
-import { tmpdir } from 'os'
-import { mkdtempSync, rmSync, readFileSync, writeFileSync, mkdirSync } from 'fs'
-import { join } from 'path'
-import dotenv from 'dotenv'
-import Ajv from 'ajv'
-import { schema } from '@platformatic/service'
-
-const base = tmpdir()
-let tmpDir
-let log = []
-beforeEach(() => {
-  tmpDir = mkdtempSync(join(base, 'test-create-platformatic-'))
-})
-
-afterEach(() => {
-  log = []
-  rmSync(tmpDir, { recursive: true, force: true })
-  process.env = {}
-})
-
-const fakeLogger = {
-  debug: msg => log.push(msg),
-  info: msg => log.push(msg)
-}
-
-test('creates service with typescript', async ({ equal, same, ok }) => {
-  const params = {
-    hostname: 'myhost',
-    port: 6666,
-    typescript: true
-  }
-
-  await createService(params, fakeLogger, tmpDir)
-
-  const pathToServiceConfigFile = join(tmpDir, 'platformatic.service.json')
-  const serviceConfigFile = readFileSync(pathToServiceConfigFile, 'utf8')
-  const serviceConfig = JSON.parse(serviceConfigFile)
-  const ajv = new Ajv()
-  ajv.addKeyword('resolvePath')
-  const validate = ajv.compile(schema.schema)
-  const isValid = validate(serviceConfig)
-  equal(isValid, true)
-  const { server, plugins } = serviceConfig
-
-  equal(server.hostname, '{PLT_SERVER_HOSTNAME}')
-  equal(server.port, '{PORT}')
-
-  const pathToDbEnvFile = join(tmpDir, '.env')
-  dotenv.config({ path: pathToDbEnvFile })
-  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
-  equal(process.env.PORT, '6666')
-  equal(process.env.PLT_TYPESCRIPT, 'true')
-
-  process.env = {}
-
-  const pathToDbEnvSampleFile = join(tmpDir, '.env.sample')
-  dotenv.config({ path: pathToDbEnvSampleFile })
-  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
-  equal(process.env.PORT, '6666')
-  equal(process.env.PLT_TYPESCRIPT, 'true')
-
-  same(plugins.paths, [{ path: './plugins', encapsulate: false }, './routes'])
-  equal(plugins.typescript, '{PLT_TYPESCRIPT}')
-
-  ok(await isFileAccessible(join(tmpDir, 'tsconfig.json')))
-  ok(await isFileAccessible(join(tmpDir, 'plugins', 'example.ts')))
-  ok(await isFileAccessible(join(tmpDir, 'routes', 'root.ts')))
-
-  ok(await isFileAccessible(join(tmpDir, 'test', 'plugins', 'example.test.ts')))
-  ok(await isFileAccessible(join(tmpDir, 'test', 'routes', 'root.test.ts')))
-  ok(await isFileAccessible(join(tmpDir, 'test', 'helper.ts')))
-})
-
-test('creates service with javascript', async ({ equal, same, ok }) => {
-  const params = {
-    hostname: 'myhost',
-    port: 6666,
-    typescript: false
-  }
-
-  await createService(params, fakeLogger, tmpDir)
-
-  const pathToServiceConfigFile = join(tmpDir, 'platformatic.service.json')
-  const serviceConfigFile = readFileSync(pathToServiceConfigFile, 'utf8')
-  const serviceConfig = JSON.parse(serviceConfigFile)
-  const { server, plugins } = serviceConfig
-
-  equal(server.hostname, '{PLT_SERVER_HOSTNAME}')
-  equal(server.port, '{PORT}')
-
-  const pathToDbEnvFile = join(tmpDir, '.env')
-  dotenv.config({ path: pathToDbEnvFile })
-  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
-  equal(process.env.PORT, '6666')
-  process.env = {}
-
-  const pathToDbEnvSampleFile = join(tmpDir, '.env.sample')
-  dotenv.config({ path: pathToDbEnvSampleFile })
-  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
-  equal(process.env.PORT, '6666')
-
-  same(plugins, { paths: [{ path: './plugins', encapsulate: false }, './routes'] })
-  ok(await isFileAccessible(join(tmpDir, 'plugins', 'example.js')))
-  ok(await isFileAccessible(join(tmpDir, 'routes', 'root.js')))
-
-  ok(await isFileAccessible(join(tmpDir, 'test', 'plugins', 'example.test.js')))
-  ok(await isFileAccessible(join(tmpDir, 'test', 'routes', 'root.test.js')))
-  ok(await isFileAccessible(join(tmpDir, 'test', 'helper.js')))
-})
-
-test('creates project with configuration already present', async ({ ok }) => {
-  const pathToServiceConfigFileOld = join(tmpDir, 'platformatic.service.json')
-  writeFileSync(pathToServiceConfigFileOld, JSON.stringify({ test: 'test' }))
-  const params = {
-    hostname: 'myhost',
-    port: 6666
-  }
-  await createService(params, fakeLogger, tmpDir)
-  ok(log.includes('Configuration file platformatic.service.json found, skipping creation of configuration file.'))
-})
-
-test('creates project with tsconfig already present', async ({ ok }) => {
-  const pathToTsConfig = join(tmpDir, 'tsconfig.json')
-  writeFileSync(pathToTsConfig, 'test')
-  const params = {
-    hostname: 'myhost',
-    port: 6666,
-    typescript: true
-  }
-  await createService(params, fakeLogger, tmpDir)
-  ok(log.includes(`Typescript configuration file ${pathToTsConfig} found, skipping creation of typescript configuration file.`))
-})
-
-test('creates project with plugins already present', async ({ ok }) => {
-  const pathToPlugins = join(tmpDir, 'plugins')
-  mkdirSync(pathToPlugins)
-  const params = {
-    hostname: 'myhost'
-  }
-  await createService(params, fakeLogger, tmpDir)
-  ok(log.includes('Plugins folder "plugins" found, skipping creation of plugins folder.'))
-})
-
-test('creates project with routes already present', async ({ ok }) => {
-  const pathToPlugins = join(tmpDir, 'routes')
-  mkdirSync(pathToPlugins)
-  const params = {
-    hostname: 'myhost'
-  }
-  await createService(params, fakeLogger, tmpDir)
-  ok(log.includes('Routes folder "routes" found, skipping creation of routes folder.'))
-})

package/test/utils.test.mjs

@@ -1,261 +0,0 @@
-import { test } from 'tap'
-import { randomBetween, sleep, validatePath, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible, isCurrentVersionSupported, minimumSupportedNodeVersions, findRuntimeConfigFile, findComposerConfigFile } from '../src/utils.mjs'
-import { mkdtempSync, rmSync, writeFileSync } from 'fs'
-import { tmpdir, platform } from 'os'
-import { join } from 'path'
-import esmock from 'esmock'
-import semver from 'semver'
-
-// esmock is broken on Node v20.6.0+
-// Resolve once https://github.com/iambumblehead/esmock/issues/234 is fixed.
-
-const skip = semver.gte(process.version, '20.6.0')
-
-test('getUsername from git', { skip }, async ({ end, equal }) => {
-  const name = 'lukeskywalker'
-  const { getUsername } = await esmock.strict('../src/utils.mjs', {
-    execa: {
-      execa: (command) => {
-        if (command === 'git') {
-          return { stdout: name }
-        }
-        return ''
-      }
-    }
-  })
-  const username = await getUsername()
-  equal(username, name)
-})
-
-test('getUsername from whoami', { skip }, async ({ end, equal }) => {
-  const name = 'hansolo'
-  const { getUsername } = await esmock.strict('../src/utils.mjs', {
-    execa: {
-      execa: (command) => {
-        if (command === 'whoami') {
-          return { stdout: name }
-        }
-        return ''
-      }
-    }
-  })
-  const username = await getUsername()
-  equal(username, name)
-})
-
-test('if getUsername from git failed, it tries whoim', { skip }, async ({ end, equal }) => {
-  const name = 'lukeskywalker'
-
-  const { getUsername } = await esmock.strict('../src/utils.mjs', {
-    execa: {
-      execa: (command) => {
-        if (command === 'git') {
-          throw new Error('git failed')
-        }
-        if (command === 'whoami') {
-          return { stdout: name }
-        }
-
-        return ''
-      }
-    }
-  })
-  const username = await getUsername()
-  equal(username, name)
-})
-
-test('if both git usern.ame and whoami fail, no username is set', { skip }, async ({ end, equal }) => {
-  const { getUsername } = await esmock.strict('../src/utils.mjs', {
-    execa: {
-      execa: (command) => {
-        if (command === 'git') {
-          throw new Error('git failed')
-        }
-        if (command === 'whoami') {
-          throw new Error('whoami failed')
-        }
-        return ''
-      }
-    }
-  })
-  const username = await getUsername()
-  equal(username, null)
-})
-
-test('getUsername - no username found', { skip }, async ({ end, equal }) => {
-  const { getUsername } = await esmock.strict('../src/utils.mjs', {
-    execa: {
-      execa: (command) => {
-        return ''
-      }
-    }
-  })
-  const username = await getUsername()
-  equal(username, null)
-})
-
-test('randomBetween', async ({ end, equal }) => {
-  const min = 1
-  const max = 10
-  const random = randomBetween(min, max)
-  equal(random >= min && random <= max, true)
-})
-
-test('sleep', async ({ equal }) => {
-  const start = Date.now()
-  await sleep(100)
-  const end = Date.now()
-  equal(end - start >= 100, true)
-})
-
-test('validatePath', async ({ end, equal, rejects, ok }) => {
-  {
-    // new folder
-    const valid = await validatePath('new-project')
-    ok(valid)
-  }
-
-  {
-    // existing folder
-    const valid = await validatePath('test')
-    ok(valid)
-  }
-
-  {
-    // current folder
-    const valid = await validatePath('.')
-    ok(valid)
-  }
-
-  if (platform().indexOf('win') < 0) {
-    // not writeable folder
-    const valid = await validatePath('/')
-    ok(!valid)
-  }
-})
-
-test('getDependencyVersion', async ({ equal }) => {
-  const fastifyVersion = await getDependencyVersion('fastify')
-  // We cannot assert the exact version because it changes
-  equal(semver.valid(fastifyVersion), fastifyVersion)
-  equal(semver.gt(fastifyVersion, '4.10.0'), true)
-})
-
-test('findDBConfigFile', async ({ end, equal, mock }) => {
-  const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const tmpDir2 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const config = join(tmpDir1, 'platformatic.db.yml')
-  writeFileSync(config, 'TEST')
-  equal(await findDBConfigFile(tmpDir1), 'platformatic.db.yml')
-  equal(await findDBConfigFile(tmpDir2), undefined)
-  rmSync(tmpDir1, { recursive: true, force: true })
-  rmSync(tmpDir2, { recursive: true, force: true })
-})
-
-test('findServiceConfigFile', async ({ end, equal, mock }) => {
-  const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const tmpDir2 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const config = join(tmpDir1, 'platformatic.service.toml')
-  writeFileSync(config, 'TEST')
-  equal(await findServiceConfigFile(tmpDir1), 'platformatic.service.toml')
-  equal(await findServiceConfigFile(tmpDir2), undefined)
-  rmSync(tmpDir1, { recursive: true, force: true })
-  rmSync(tmpDir2, { recursive: true, force: true })
-})
-
-test('findComposerConfigFile', async ({ end, equal, mock }) => {
-  const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const tmpDir2 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const config = join(tmpDir1, 'platformatic.composer.yml')
-  writeFileSync(config, 'TEST')
-  equal(await findComposerConfigFile(tmpDir1), 'platformatic.composer.yml')
-  equal(await findComposerConfigFile(tmpDir2), undefined)
-  rmSync(tmpDir1, { recursive: true, force: true })
-  rmSync(tmpDir2, { recursive: true, force: true })
-})
-
-test('findRuntimeConfigFile', async ({ end, equal, mock }) => {
-  const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const tmpDir2 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const config = join(tmpDir1, 'platformatic.runtime.yml')
-  writeFileSync(config, 'TEST')
-  equal(await findRuntimeConfigFile(tmpDir1), 'platformatic.runtime.yml')
-  equal(await findRuntimeConfigFile(tmpDir2), undefined)
-  rmSync(tmpDir1, { recursive: true, force: true })
-  rmSync(tmpDir2, { recursive: true, force: true })
-})
-
-test('isFileAccessible', async ({ end, equal, mock }) => {
-  const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
-  const config = join(tmpDir1, 'platformatic.db.yml')
-  writeFileSync(config, 'TEST')
-  equal(await isFileAccessible(config), true)
-  const config2 = join(tmpDir1, 'platformatic2.db.yml')
-  equal(await isFileAccessible(config2), false)
-  rmSync(tmpDir1, { recursive: true, force: true })
-})
-
-test('minimumSupportedNodeVersions', async ({ equal, not }) => {
-  equal(Array.isArray(minimumSupportedNodeVersions), true)
-  not(minimumSupportedNodeVersions.length, 0)
-})
-
-test('isCurrentVersionSupported', async ({ equal }) => {
-  const { major, minor, patch } = semver.minVersion(minimumSupportedNodeVersions[0])
-  {
-    // major - 1 not supported
-    const nodeVersion = `${major - 1}.${minor}.${patch}`
-    const supported = isCurrentVersionSupported(nodeVersion)
-    equal(supported, false)
-  }
-  {
-    // minor - 1 not supported
-    const nodeVersion = `${major}.${minor - 1}.${patch}`
-    const supported = isCurrentVersionSupported(nodeVersion)
-    equal(supported, false)
-  }
-  {
-    // v16 more than minimum is supported
-    const supported = isCurrentVersionSupported(`${major}.${minor + 2}.${patch}`)
-    equal(supported, true)
-  }
-
-  // node version 20 test, to check greater and lesser major version
-  {
-    // v18.0.0 is not supported
-    const nodeVersion = '18.0.0'
-    const supported = isCurrentVersionSupported(nodeVersion)
-    equal(supported, false)
-  }
-  {
-    // v18.8.0 is supported
-    const nodeVersion = '18.8.0'
-    const supported = isCurrentVersionSupported(nodeVersion)
-    equal(supported, true)
-  }
-  {
-    // v20.5.1 is not supported
-    const supported = isCurrentVersionSupported('20.5.1')
-    equal(supported, false)
-  }
-  {
-    // v20.6.0 is supported
-    const nodeVersion = '20.6.0'
-    const supported = isCurrentVersionSupported(nodeVersion)
-    equal(supported, true)
-  }
-  {
-    // v19.0.0 is not supported
-    const supported = isCurrentVersionSupported('19.0.0')
-    equal(supported, false)
-  }
-  {
-    // v19.9.0 is not supported
-    const supported = isCurrentVersionSupported('19.9.0')
-    equal(supported, false)
-  }
-  for (const version of minimumSupportedNodeVersions) {
-    const supported = isCurrentVersionSupported(version)
-    equal(supported, true)
-  }
-})