create-platformatic 0.45.1 → 0.46.2

package/test/get-pkg-manager.test.mjs

@@ -1,36 +0,0 @@
-import { test, beforeEach } from 'tap'
-import { getPkgManager } from '../src/get-pkg-manager.mjs'
-
-beforeEach(() => {
-  delete process.env.npm_config_user_agent
-})
-
-test('detects npm', async ({ end, equal }) => {
-  process.env.npm_config_user_agent = 'npm/7.18.1 node/v16.4.2 darwin x64'
-  equal(getPkgManager(), 'npm')
-})
-
-test('detects yarn', async ({ end, equal }) => {
-  process.env.npm_config_user_agent = 'yarn/1.22.10 npm/? node/v16.4.2 darwin x64'
-  equal(getPkgManager(), 'yarn')
-})
-
-test('detects pnpm', async ({ end, equal }) => {
-  process.env.npm_config_user_agent = 'pnpm/6.14.1 npm/? node/v16.4.2 darwin x64'
-  equal(getPkgManager(), 'pnpm')
-})
-
-test('detects cnpm', async ({ end, equal }) => {
-  process.env.npm_config_user_agent = 'cnpm/7.0.0 npminsall/1.0.0 node/v16.4.2 darwin x64'
-  equal(getPkgManager(), 'cnpm')
-})
-
-test('defaults to npm if the user agent is unknown', async ({ end, equal }) => {
-  process.env.npm_config_user_agent = 'xxxxxxxxxxxxxxxxxx'
-  equal(getPkgManager(), 'npm')
-})
-
-test('defaults to npm if the user agent is not set', async ({ end, equal }) => {
-  delete process.env.npm_config_user_agent
-  equal(getPkgManager(), 'npm')
-})

package/test/ghaction-dynamic.test.mjs

@@ -1,98 +0,0 @@
-'use strict'
-
-import { test, beforeEach, afterEach } from 'tap'
-import { mkdtemp, rmdir, writeFile, readFile, mkdir } from 'fs/promises'
-import { join } from 'path'
-import { tmpdir } from 'os'
-import { isFileAccessible } from '../src/utils.mjs'
-import { createDynamicWorkspaceGHAction } from '../src/ghaction.mjs'
-import { parse } from 'yaml'
-
-let log = []
-let tmpDir
-const fakeLogger = {
-  info: msg => { log.push(msg) },
-  warn: msg => { log.push(msg) }
-}
-
-beforeEach(async () => {
-  log = []
-  tmpDir = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
-})
-
-afterEach(async () => {
-  await rmdir(tmpDir, { recursive: true, force: true })
-})
-
-const env = {
-  DATABASE_URL: 'mydbconnectionstring',
-  PLT_SERVER_LOGGER_LEVEL: 'info'
-}
-
-test('creates gh action', async ({ equal, match }) => {
-  await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, false)
-  equal(log[0], 'PR Previews are enabled for your app and the Github action was successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
-  equal(accessible, true)
-  const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'), 'utf8')
-  const ghAction = parse(ghFile)
-  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
-  equal(steps.length, 3)
-  equal(steps[0].name, 'Checkout application project repository')
-  equal(steps[1].name, 'npm install --omit=dev')
-  equal(steps[2].name, 'Deploy project')
-  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
-
-  equal(permissions.contents, 'read')
-  equal(permissions['pull-requests'], 'write')
-})
-
-test('creates gh action with TS build step', async ({ equal, match }) => {
-  await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, true)
-  equal(log[0], 'PR Previews are enabled for your app and the Github action was successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
-  equal(accessible, true)
-  const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'), 'utf8')
-  const ghAction = parse(ghFile)
-  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
-  equal(steps.length, 4)
-  equal(steps[0].name, 'Checkout application project repository')
-  equal(steps[1].name, 'npm install --omit=dev')
-  equal(steps[2].name, 'Build project')
-  equal(steps[3].name, 'Deploy project')
-  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
-
-  equal(permissions.contents, 'read')
-  equal(permissions['pull-requests'], 'write')
-})
-
-test('do not create gitignore file because already present', async ({ end, equal }) => {
-  await mkdir(join(tmpDir, '.github', 'workflows'), { recursive: true })
-  const ghaction = join(tmpDir, '.github', 'workflows', 'platformatic-dynamic-workspace-deploy.yml')
-  await writeFile(ghaction, 'TEST')
-  await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], `Github action file ${join(tmpDir, '.github', 'workflows', 'platformatic-dynamic-workspace-deploy.yml')} found, skipping creation of github action file.`)
-})
-
-test('creates gh action with a warn if a .git folder is not present', async ({ end, equal }) => {
-  await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'PR Previews are enabled for your app and the Github action was successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
-  equal(accessible, true)
-  const secretsLogLine = log[1].split('\n')
-  equal(secretsLogLine[1].trim(), 'PLATFORMATIC_DYNAMIC_WORKSPACE_ID: your workspace id')
-  equal(secretsLogLine[2].trim(), 'PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY: your workspace API key')
-  equal(secretsLogLine[3].trim(), 'DATABASE_URL: mydbconnectionstring')
-  equal(log[2], 'No git repository found. The Github action won\'t be triggered.')
-})
-
-test('creates gh action without a warn if a .git folder is present', async ({ end, equal }) => {
-  await mkdir(join(tmpDir, '.git'), { recursive: true })
-  await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'PR Previews are enabled for your app and the Github action was successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
-  equal(accessible, true)
-  equal(log.length, 2)
-})

package/test/ghaction-static.test.mjs

@@ -1,97 +0,0 @@
-'use strict'
-
-import { test, beforeEach, afterEach } from 'tap'
-import { mkdtemp, rmdir, writeFile, readFile, mkdir } from 'fs/promises'
-import { join } from 'path'
-import { tmpdir } from 'os'
-import { isFileAccessible } from '../src/utils.mjs'
-import { createStaticWorkspaceGHAction } from '../src/ghaction.mjs'
-import { parse } from 'yaml'
-
-let log = []
-let tmpDir
-const fakeLogger = {
-  info: msg => { log.push(msg) },
-  warn: msg => { log.push(msg) }
-}
-
-beforeEach(async () => {
-  log = []
-  tmpDir = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
-})
-
-afterEach(async () => {
-  await rmdir(tmpDir, { recursive: true, force: true })
-})
-
-const env = {
-  DATABASE_URL: 'mydbconnectionstring',
-  PLT_SERVER_LOGGER_LEVEL: 'info'
-}
-
-test('creates gh action', async ({ equal, match }) => {
-  await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, false)
-  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
-  equal(accessible, true)
-  const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'), 'utf8')
-  const ghAction = parse(ghFile)
-  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
-
-  equal(steps.length, 3)
-  equal(steps[0].name, 'Checkout application project repository')
-  equal(steps[1].name, 'npm install --omit=dev')
-  equal(steps[2].name, 'Deploy project')
-  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
-
-  equal(permissions.contents, 'read')
-})
-
-test('creates gh action with TS build step', async ({ equal, match }) => {
-  await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir, true)
-  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
-  equal(accessible, true)
-  const ghFile = await readFile(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'), 'utf8')
-  const ghAction = parse(ghFile)
-  const { steps, permissions, env: jobEnv } = ghAction.jobs.build_and_deploy
-  equal(steps.length, 4)
-  equal(steps[0].name, 'Checkout application project repository')
-  equal(steps[1].name, 'npm install --omit=dev')
-  equal(steps[2].name, 'Build project')
-  equal(steps[3].name, 'Deploy project')
-  match(jobEnv.DATABASE_URL, /\$\{\{ secrets.DATABASE_URL \}\}/)
-  equal(jobEnv.PLT_SERVER_LOGGER_LEVEL, 'info')
-
-  equal(permissions.contents, 'read')
-})
-
-test('do not create gitignore file because already present', async ({ end, equal }) => {
-  await mkdir(join(tmpDir, '.github', 'workflows'), { recursive: true })
-  const ghaction = join(tmpDir, '.github', 'workflows', 'platformatic-static-workspace-deploy.yml')
-  await writeFile(ghaction, 'TEST')
-  await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], `Github action file ${join(tmpDir, '.github', 'workflows', 'platformatic-static-workspace-deploy.yml')} found, skipping creation of github action file.`)
-})
-
-test('creates gh action with a warn if a .git folder is not present', async ({ end, equal }) => {
-  await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
-  equal(accessible, true)
-  const secretsLogLine = log[1].split('\n')
-  equal(secretsLogLine[1].trim(), 'PLATFORMATIC_STATIC_WORKSPACE_ID: your workspace id')
-  equal(secretsLogLine[2].trim(), 'PLATFORMATIC_STATIC_WORKSPACE_API_KEY: your workspace API key')
-  equal(secretsLogLine[3].trim(), 'DATABASE_URL: mydbconnectionstring')
-  equal(log[2], 'No git repository found. The Github action won\'t be triggered.')
-})
-
-test('creates gh action without a warn if a .git folder is present', async ({ end, equal }) => {
-  await mkdir(join(tmpDir, '.git'), { recursive: true })
-  await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
-  equal(log[0], 'Github action successfully created, please add the following secrets as repository secrets: ')
-  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
-  equal(accessible, true)
-  equal(log.length, 2)
-})

package/test/runtime/create-runtime.test.mjs

@@ -1,70 +0,0 @@
-import createRuntime from '../../src/runtime/create-runtime.mjs'
-import { test, beforeEach, afterEach } from 'tap'
-import { tmpdir } from 'os'
-import { mkdtempSync, rmSync, readFileSync, writeFileSync } from 'fs'
-import { join } from 'path'
-
-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 runtime', async ({ equal, same, ok }) => {
-  await createRuntime(fakeLogger, tmpDir, undefined, 'library-app/services', 'foobar')
-
-  const pathToRuntimeConfigFile = join(tmpDir, 'platformatic.runtime.json')
-  const runtimeConfigFile = readFileSync(pathToRuntimeConfigFile, 'utf8')
-  const runtimeConfig = JSON.parse(runtimeConfigFile)
-
-  delete runtimeConfig.$schema
-
-  same(runtimeConfig, {
-    entrypoint: 'foobar',
-    allowCycles: false,
-    hotReload: true,
-    autoload: {
-      path: 'library-app/services',
-      exclude: ['docs']
-    }
-  })
-})
-
-test('with a full path for autoload', async ({ equal, same, ok }) => {
-  await createRuntime(fakeLogger, tmpDir, undefined, join(tmpDir, 'services'), 'foobar')
-
-  const pathToRuntimeConfigFile = join(tmpDir, 'platformatic.runtime.json')
-  const runtimeConfigFile = readFileSync(pathToRuntimeConfigFile, 'utf8')
-  const runtimeConfig = JSON.parse(runtimeConfigFile)
-
-  delete runtimeConfig.$schema
-
-  same(runtimeConfig, {
-    entrypoint: 'foobar',
-    allowCycles: false,
-    hotReload: true,
-    autoload: {
-      path: 'services',
-      exclude: ['docs']
-    }
-  })
-})
-
-test('creates project with configuration already present', async ({ ok }) => {
-  const pathToRuntimeConfigFileOld = join(tmpDir, 'platformatic.runtime.json')
-  writeFileSync(pathToRuntimeConfigFileOld, JSON.stringify({ test: 'test' }))
-  await createRuntime(fakeLogger, tmpDir, 'foobar')
-  ok(log.includes('Configuration file platformatic.runtime.json found, skipping creation of configuration file.'))
-})

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

@@ -1,147 +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')))
-})
-
-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')))
-})
-
-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.'))
-})