create-platformatic 0.11.0

package/test/create-gitignore.test.mjs

@@ -0,0 +1,35 @@
+import { test, beforeEach, afterEach } from 'tap'
+import { tmpdir } from 'os'
+import { isFileAccessible } from '../src/utils.mjs'
+import { createGitignore } from '../src/create-gitignore.mjs'
+import { mkdtempSync, rmSync, writeFileSync } from 'fs'
+import { join } from 'path'
+
+let log = ''
+const fakeLogger = {
+  debug: msg => { log = msg }
+}
+
+let tmpDir
+beforeEach(() => {
+  log = ''
+  tmpDir = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
+})
+
+afterEach(() => {
+  rmSync(tmpDir, { recursive: true, force: true })
+})
+
+test('creates gitignore file', async ({ end, equal }) => {
+  await createGitignore(fakeLogger, tmpDir)
+  equal(log, `Gitignore file ${tmpDir}/.gitignore successfully created.`)
+  const accessible = await isFileAccessible(join(tmpDir, '.gitignore'))
+  equal(accessible, true)
+})
+
+test('do not create gitignore file because already present', async ({ end, equal }) => {
+  const gitignore = join(tmpDir, '.gitignore')
+  writeFileSync(gitignore, 'TEST')
+  await createGitignore(fakeLogger, tmpDir)
+  equal(log, `Gitignore file ${tmpDir}/.gitignore found, skipping creation of gitignore file.`)
+})

package/test/create-package-json.test.mjs

@@ -0,0 +1,56 @@
+import { test, beforeEach, afterEach } from 'tap'
+import { tmpdir } from 'os'
+import { isFileAccessible } from '../src/utils.mjs'
+import { createPackageJson } from '../src/create-package-json.mjs'
+import { mkdtempSync, rmSync, writeFileSync, readFileSync } from 'fs'
+import { join } from 'path'
+
+let log = ''
+const fakeLogger = {
+  debug: msg => { log = msg }
+}
+
+let tmpDir
+beforeEach(() => {
+  log = ''
+  tmpDir = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
+})
+
+afterEach(() => {
+  rmSync(tmpDir, { recursive: true, force: true })
+})
+
+test('creates package.json file for db project', async ({ end, equal }) => {
+  const version = '1.2.3'
+  const fastifyVersion = '4.5.6'
+  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir)
+  equal(log, `${tmpDir}/package.json successfully created.`)
+  const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
+  equal(accessible, true)
+  const packageJson = JSON.parse(readFileSync(join(tmpDir, 'package.json')))
+  equal(packageJson.scripts.start, 'platformatic db start')
+  equal(packageJson.dependencies.platformatic, `^${version}`)
+  equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
+})
+
+test('creates package.json file for service project', async ({ end, equal }) => {
+  const version = '1.2.3'
+  const fastifyVersion = '4.5.6'
+  await createPackageJson('service', version, fastifyVersion, fakeLogger, tmpDir)
+  equal(log, `${tmpDir}/package.json successfully created.`)
+  const accessible = await isFileAccessible(join(tmpDir, 'package.json'))
+  equal(accessible, true)
+  const packageJson = JSON.parse(readFileSync(join(tmpDir, 'package.json')))
+  equal(packageJson.scripts.start, 'platformatic service start')
+  equal(packageJson.dependencies.platformatic, `^${version}`)
+  equal(packageJson.devDependencies.fastify, `^${fastifyVersion}`)
+})
+
+test('do not create package.json file because already present', async ({ end, equal }) => {
+  const version = '1.2.3'
+  const fastifyVersion = '4.5.6'
+  const packagejson = join(tmpDir, 'package.json')
+  writeFileSync(packagejson, 'TEST')
+  await createPackageJson('db', version, fastifyVersion, fakeLogger, tmpDir)
+  equal(log, `${tmpDir}/package.json found, skipping creation of package.json file.`)
+})

package/test/db/create-db.test.mjs

@@ -0,0 +1,241 @@
+import createDB from '../../src/db/create-db.mjs'
+import { test, beforeEach, afterEach } from 'tap'
+import { isFileAccessible } from '../../src/utils.mjs'
+import { tmpdir } from 'os'
+import { mkdtempSync, rmSync, readFileSync, writeFileSync, mkdirSync } from 'fs'
+import { join } from 'path'
+import dotenv from 'dotenv'
+
+const moviesMigrationDo = `
+-- Add SQL in this file to create the database tables for your API
+CREATE TABLE IF NOT EXISTS movies (
+  id INTEGER PRIMARY KEY,
+  title TEXT NOT NULL
+);
+`
+
+const moviesMigrationUndo = `
+-- Add SQL in this file to drop the database tables 
+DROP TABLE movies;
+`
+
+let tmpDir
+let log = []
+beforeEach(() => {
+  tmpDir = mkdtempSync(join(tmpdir(), '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 project with no typescript', async ({ end, equal }) => {
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    plugin: true
+  }
+
+  await createDB(params, fakeLogger, tmpDir)
+
+  const pathToDbConfigFile = join(tmpDir, 'platformatic.db.json')
+  const pathToMigrationFolder = join(tmpDir, 'migrations')
+  const pathToMigrationFileDo = join(pathToMigrationFolder, '001.do.sql')
+  const pathToMigrationFileUndo = join(pathToMigrationFolder, '001.undo.sql')
+
+  const dbConfigFile = readFileSync(pathToDbConfigFile, 'utf8')
+  const dbConfig = JSON.parse(dbConfigFile)
+  const { server, core, migrations } = dbConfig
+
+  equal(server.hostname, '{PLT_SERVER_HOSTNAME}')
+  equal(server.port, '{PORT}')
+  equal(core.connectionString, '{DATABASE_URL}')
+
+  const pathToDbEnvFile = join(tmpDir, '.env')
+  dotenv.config({ path: pathToDbEnvFile })
+  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
+  equal(process.env.PORT, '6666')
+  equal(process.env.DATABASE_URL, 'sqlite://./db.sqlite')
+  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.DATABASE_URL, 'sqlite://./db.sqlite')
+
+  equal(core.graphql, true)
+  equal(core.openapi, true)
+  equal(migrations.dir, 'migrations')
+
+  const migrationFileDo = await readFileSync(pathToMigrationFileDo, 'utf8')
+  equal(migrationFileDo, moviesMigrationDo)
+  const migrationFileUndo = await readFileSync(pathToMigrationFileUndo, 'utf8')
+  equal(migrationFileUndo, moviesMigrationUndo)
+
+  equal(await isFileAccessible(join(tmpDir, 'plugin.js')), true)
+})
+
+test('creates project with no typescript and no plugin', async ({ end, equal }) => {
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    plugin: false
+  }
+
+  await createDB(params, fakeLogger, tmpDir)
+
+  const pathToDbConfigFile = join(tmpDir, 'platformatic.db.json')
+  const pathToMigrationFolder = join(tmpDir, 'migrations')
+  const pathToMigrationFileDo = join(pathToMigrationFolder, '001.do.sql')
+  const pathToMigrationFileUndo = join(pathToMigrationFolder, '001.undo.sql')
+
+  const dbConfigFile = readFileSync(pathToDbConfigFile, 'utf8')
+  const dbConfig = JSON.parse(dbConfigFile)
+  const { server, core, migrations } = dbConfig
+
+  equal(server.hostname, '{PLT_SERVER_HOSTNAME}')
+  equal(server.port, '{PORT}')
+  equal(core.connectionString, '{DATABASE_URL}')
+
+  const pathToDbEnvFile = join(tmpDir, '.env')
+  dotenv.config({ path: pathToDbEnvFile })
+  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
+  equal(process.env.PORT, '6666')
+  equal(process.env.DATABASE_URL, 'sqlite://./db.sqlite')
+  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.DATABASE_URL, 'sqlite://./db.sqlite')
+
+  equal(core.graphql, true)
+  equal(core.openapi, true)
+  equal(migrations.dir, 'migrations')
+
+  const migrationFileDo = await readFileSync(pathToMigrationFileDo, 'utf8')
+  equal(migrationFileDo, moviesMigrationDo)
+  const migrationFileUndo = await readFileSync(pathToMigrationFileUndo, 'utf8')
+  equal(migrationFileUndo, moviesMigrationUndo)
+
+  equal(await isFileAccessible(join(tmpDir, 'plugin.js')), false)
+})
+
+test('creates project with typescript', async ({ end, equal }) => {
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    typescript: true
+  }
+
+  await createDB(params, fakeLogger, tmpDir)
+
+  const pathToDbConfigFile = join(tmpDir, 'platformatic.db.json')
+  const pathToMigrationFolder = join(tmpDir, 'migrations')
+  const pathToMigrationFileDo = join(pathToMigrationFolder, '001.do.sql')
+  const pathToMigrationFileUndo = join(pathToMigrationFolder, '001.undo.sql')
+
+  const dbConfigFile = readFileSync(pathToDbConfigFile, 'utf8')
+  const dbConfig = JSON.parse(dbConfigFile)
+  const { server, core, migrations, plugin } = dbConfig
+
+  equal(server.hostname, '{PLT_SERVER_HOSTNAME}')
+  equal(server.port, '{PORT}')
+  equal(core.connectionString, '{DATABASE_URL}')
+
+  const pathToDbEnvFile = join(tmpDir, '.env')
+  dotenv.config({ path: pathToDbEnvFile })
+  equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
+  equal(process.env.PORT, '6666')
+  equal(process.env.DATABASE_URL, 'sqlite://./db.sqlite')
+  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.DATABASE_URL, 'sqlite://./db.sqlite')
+
+  equal(core.graphql, true)
+  equal(core.openapi, true)
+  equal(migrations.dir, 'migrations')
+
+  const migrationFileDo = await readFileSync(pathToMigrationFileDo, 'utf8')
+  equal(migrationFileDo, moviesMigrationDo)
+  const migrationFileUndo = await readFileSync(pathToMigrationFileUndo, 'utf8')
+  equal(migrationFileUndo, moviesMigrationUndo)
+
+  equal(plugin.path, 'plugin.ts')
+  equal(plugin.typescript.outDir, 'dist')
+  equal(await isFileAccessible(join(tmpDir, 'plugin.ts')), true)
+  equal(await isFileAccessible(join(tmpDir, 'tsconfig.json')), true)
+})
+
+test('creates project with configuration already present', async ({ end, equal, ok }) => {
+  const pathToDbConfigFileOld = join(tmpDir, 'platformatic.db.json')
+  writeFileSync(pathToDbConfigFileOld, JSON.stringify({ test: 'test' }))
+  const params = {
+    hostname: 'myhost',
+    port: 6666
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  ok(log.includes('Configuration file platformatic.db.json found, skipping creation of configuration file.'))
+})
+
+test('creates project with migration folder already present', async ({ end, equal, ok }) => {
+  const pathToMigrationsOld = join(tmpDir, 'migrations')
+  mkdirSync(pathToMigrationsOld)
+  const params = {
+    hostname: 'myhost',
+    port: 6666
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  equal(log.includes('Migrations folder migrations found, skipping creation of migrations folder.'), true)
+})
+
+test('creates project with "do" migration already present', async ({ end, equal, ok }) => {
+  const pathToMigrationsOld = join(tmpDir, 'migrations')
+  mkdirSync(pathToMigrationsOld)
+  const pathToMigrationFileDo = join(pathToMigrationsOld, '001.do.sql')
+  writeFileSync(pathToMigrationFileDo, 'test')
+  const params = {
+    hostname: 'myhost',
+    port: 6666
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  ok(log.includes('Migration file 001.do.sql found, skipping creation of migration file.'))
+})
+
+test('creates project with tsconfig already present', async ({ end, equal, ok }) => {
+  const pathToTsConfig = join(tmpDir, 'tsconfig.json')
+  writeFileSync(pathToTsConfig, 'test')
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    typescript: true
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  ok(log.includes(`Typescript configuration file ${pathToTsConfig} found, skipping creation of typescript configuration file.`))
+})
+
+test('creates project with plugin already present', async ({ end, equal, ok }) => {
+  const pathToPlugin = join(tmpDir, 'plugin.js')
+  writeFileSync(pathToPlugin, 'test')
+  const params = {
+    hostname: 'myhost',
+    port: 6666,
+    plugin: true,
+    types: true
+  }
+  await createDB(params, fakeLogger, tmpDir)
+  ok(log.includes(`Plugin file ${pathToPlugin} found, skipping creation of plugin file.`))
+})

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

@@ -0,0 +1,36 @@
+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.test.mjs

@@ -0,0 +1,62 @@
+'use strict'
+
+import { test, beforeEach, afterEach } from 'tap'
+import { mkdtemp, rmdir, writeFile } from 'fs/promises'
+import mkdirp from 'mkdirp'
+import { join } from 'path'
+import { tmpdir } from 'os'
+import { isFileAccessible } from '../src/utils.mjs'
+import { createGHAction } from '../src/ghaction.mjs'
+
+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: 'mydbconnetionstring',
+  PLT_SERVER_LOGGER_LEVEL: 'info'
+}
+
+test('creates gh action', async ({ end, equal }) => {
+  await createGHAction(fakeLogger, env, 'db', tmpDir)
+  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_API_KEY as repository secret.')
+  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-deploy.yml'))
+  equal(accessible, true)
+})
+
+test('do not create gitignore file because already present', async ({ end, equal }) => {
+  await mkdirp(join(tmpDir, '.github', 'workflows'))
+  const ghaction = join(tmpDir, '.github', 'workflows', 'platformatic-deploy.yml')
+  await writeFile(ghaction, 'TEST')
+  await createGHAction(fakeLogger, env, 'db', tmpDir)
+  equal(log[0], `Github action file ${tmpDir}/.github/workflows/platformatic-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 createGHAction(fakeLogger, env, 'db', tmpDir)
+  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_API_KEY as repository secret.')
+  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-deploy.yml'))
+  equal(accessible, true)
+  equal(log[1], '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 mkdirp(join(tmpDir, '.git'))
+  await createGHAction(fakeLogger, env, 'db', tmpDir)
+  equal(log[0], 'Github action successfully created, please add PLATFORMATIC_API_KEY as repository secret.')
+  const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-deploy.yml'))
+  equal(accessible, true)
+  equal(log.length, 1)
+})

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

@@ -0,0 +1,88 @@
+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'
+
+let tmpDir
+let log = []
+beforeEach(() => {
+  tmpDir = mkdtempSync(join(tmpdir(), '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 no typescript', async ({ end, 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, plugin } = 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(plugin, ['./plugins', './routes'])
+  ok(isFileAccessible(join(tmpDir, 'plugins', 'examples.js')))
+  ok(isFileAccessible(join(tmpDir, 'routes', 'root.js')))
+})
+
+test('creates project with configuration already present', async ({ end, equal, 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 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.'))
+})