create-platformatic 1.49.1 → 1.51.8

package/test/cli/stackable.test.mjs

@@ -0,0 +1,101 @@
+import { test } from 'node:test'
+import { equal } from 'node:assert'
+import { executeCreatePlatformatic, keys, walk } from './helper.mjs'
+import { timeout } from './timeout.mjs'
+import { isFileAccessible } from '../../src/utils.mjs'
+import { join } from 'node:path'
+import { tmpdir } from 'os'
+import { mkdtemp, rm } from 'node:fs/promises'
+
+let tmpDir
+test.beforeEach(async () => {
+  tmpDir = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+})
+
+test.afterEach(async () => {
+  try {
+    await rm(tmpDir, { recursive: true, force: true })
+  } catch (e) {
+    // on purpose, in win the resource might be still "busy"
+  }
+})
+
+test('Creates a Platformatic Stackable without typescript', { timeout }, async () => {
+  // The actions must match IN ORDER
+  const actions = [{
+    match: 'What kind of project do you want to create?',
+    do: [keys.DOWN, keys.ENTER] // Stackable
+  }, {
+    match: 'Where would you like to create your project?',
+    do: [keys.ENTER]
+  }, {
+    match: 'What is the name of the stackable?',
+    do: [keys.ENTER] // my-stackable
+  }, {
+    match: 'Do you want to use TypeScript',
+    do: [keys.ENTER] // no
+  }, {
+    match: 'Do you want to init the git repository',
+    do: [keys.DOWN, keys.ENTER] // yes
+  }]
+  await executeCreatePlatformatic(tmpDir, actions, {
+    done: 'Stackable created successfully!'
+  })
+
+  const baseProjectDir = join(tmpDir, 'platformatic')
+  const files = await walk(baseProjectDir)
+  console.log('==> created files', files)
+  equal(await isFileAccessible(join(baseProjectDir, '.gitignore')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'index.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'index.d.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'config.d.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'package.json')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'plugins', 'example.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'lib', 'schema.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'lib', 'generator.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'cli', 'create.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'cli', 'start.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'test', 'index.test.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'test', 'schema.test.js')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'test', 'generator.test.js')), true)
+})
+
+test('Creates a Platformatic Stackable with typescript', { timeout }, async () => {
+  // The actions must match IN ORDER
+  const actions = [{
+    match: 'What kind of project do you want to create?',
+    do: [keys.DOWN, keys.ENTER] // Stackable
+  }, {
+    match: 'Where would you like to create your project?',
+    do: [keys.ENTER]
+  }, {
+    match: 'What is the name of the stackable?',
+    do: [keys.ENTER] // my-stackable
+  }, {
+    match: 'Do you want to use TypeScript',
+    do: [keys.DOWN, keys.ENTER] // yes
+  }, {
+    match: 'Do you want to init the git repository',
+    do: [keys.ENTER] // no
+  }]
+  await executeCreatePlatformatic(tmpDir, actions, {
+    done: 'Stackable created successfully!'
+  })
+
+  const baseProjectDir = join(tmpDir, 'platformatic')
+  const files = await walk(baseProjectDir)
+  console.log('==> created files', files)
+  equal(await isFileAccessible(join(baseProjectDir, '.gitignore')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'index.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'index.d.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'config.d.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'package.json')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'plugins', 'example.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'lib', 'schema.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'lib', 'generator.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'cli', 'create.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'cli', 'start.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'test', 'index.test.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'test', 'schema.test.ts')), true)
+  equal(await isFileAccessible(join(baseProjectDir, 'test', 'generator.test.ts')), true)
+})

package/test/cli/timeout.mjs

@@ -0,0 +1,3 @@
+'use strict'
+
+export const timeout = 120_000

package/test/unit/create-git-repository.test.mjs

@@ -0,0 +1,61 @@
+import { tmpdir } from 'os'
+import { join } from 'path'
+import { execa } from 'execa'
+import { test } from 'node:test'
+import { equal, match } from 'node:assert'
+
+import { isFileAccessible } from '../../src/utils.mjs'
+import { createGitRepository, GIT_FIRST_COMMIT_MESSAGE, GIT_MAIN_BRANCH } from '../../src/create-git-repository.mjs'
+import { mkdir, rm, writeFile } from 'fs/promises'
+
+const loggerSpy = {
+  _debug: [],
+  _info: [],
+  _error: [],
+
+  debug: function (...args) { this._debug.push(args) },
+  info: function (...args) { this._info.push(args) },
+  error: function (...args) { this._error.push(args) },
+
+  reset: function () {
+    this._debug = []
+    this._info = []
+    this._error = []
+  }
+}
+
+const tmpDir = join(tmpdir(), 'test-create-platformatic-git-repo')
+test.beforeEach(async () => {
+  loggerSpy.reset()
+  await rm(tmpDir, { recursive: true, force: true })
+  await mkdir(tmpDir, { recursive: true })
+})
+
+test('should create the git repo', async () => {
+  await writeFile(join(tmpDir, 'README.md'), '')
+
+  await createGitRepository(loggerSpy, tmpDir)
+
+  equal(loggerSpy._debug[0][0], 'Git repository initialized.')
+  equal(loggerSpy._debug[1][0], 'Git commit done.')
+  equal(loggerSpy._info[0][0], 'Git repository initialized.')
+  equal(loggerSpy._error.length, 0)
+
+  equal(await isFileAccessible(join(tmpDir, '.git/config')), true)
+
+  const lastCommit = await execa('git', ['show', '-1'], { cwd: tmpDir })
+  match(lastCommit.stdout, new RegExp(GIT_FIRST_COMMIT_MESSAGE))
+
+  const branch = await execa('git', ['branch'], { cwd: tmpDir })
+  match(branch.stdout, new RegExp(GIT_MAIN_BRANCH))
+})
+
+test('should not create the git repository if already exists', async () => {
+  await execa('git', ['init'], { cwd: tmpDir })
+
+  await createGitRepository(loggerSpy, tmpDir)
+
+  equal(loggerSpy._debug.length, 0)
+  equal(loggerSpy._info[0][0], 'Git repository already exists.')
+  equal(loggerSpy._error.length, 0)
+})

package/test/unit/fetch-stackables.mjs

@@ -0,0 +1,71 @@
+import { test } from 'node:test'
+import { deepEqual } from 'node:assert'
+import { MockAgent, setGlobalDispatcher } from 'undici'
+import { fetchStackables } from '../../src/index.mjs'
+import { setTimeout } from 'node:timers/promises'
+
+const mockAgent = new MockAgent({
+  keepAliveTimeout: 10,
+  keepAliveMaxTimeout: 10
+})
+mockAgent.disableNetConnect()
+
+setGlobalDispatcher(mockAgent)
+
+const MARKETPLACE_HOST = 'https://marketplace.platformatic.dev'
+
+const mockPool = mockAgent.get(MARKETPLACE_HOST)
+const defaultStackables = ['@platformatic/composer', '@platformatic/db', '@platformatic/service']
+
+test('should fetch stackables from the marketplace', async () => {
+  const mockStackables = [
+    { name: 'mock-service-1' },
+    { name: 'mock-service-2' },
+    { name: 'mock-service-3' }
+  ]
+
+  mockPool.intercept({ path: '/templates' }).reply(200, mockStackables)
+
+  const stackables = await fetchStackables()
+  deepEqual(stackables, mockStackables.map(s => s.name))
+})
+
+test('should fetch private stackables from the marketplace', async () => {
+  const mockStackables = [
+    { name: 'mock-service-1' },
+    { name: 'mock-service-2' },
+    { name: 'mock-service-3' },
+    { name: 'private-mock-service-1' }
+  ]
+
+  mockPool.intercept({ path: '/templates' }).reply(200, mockStackables)
+
+  const stackables = await fetchStackables(MARKETPLACE_HOST)
+  deepEqual(stackables, mockStackables.map(s => s.name))
+})
+
+test('should fetch only public stackables if user api key is wrong', async () => {
+  const mockStackables = [
+    { name: 'mock-service-1' },
+    { name: 'mock-service-2' },
+    { name: 'mock-service-3' }
+  ]
+
+  mockPool.intercept({ path: '/templates' }).reply(401)
+  mockPool.intercept({ path: '/templates' }).reply(200, mockStackables)
+
+  const stackables = await fetchStackables(MARKETPLACE_HOST)
+  deepEqual(stackables, mockStackables.map(s => s.name))
+})
+
+test('should return default stackables if fetching from the marketplace takes too long', async () => {
+  mockPool.intercept({ path: '/templates' }).reply(200, async () => await setTimeout(6000, []))
+  const stackables = await fetchStackables()
+  deepEqual(stackables, defaultStackables)
+})
+
+test('should return default stackables if fetching from the marketplace errors', async () => {
+  mockPool.intercept({ path: '/templates' }).replyWithError(new Error())
+  const stackables = await fetchStackables()
+  deepEqual(stackables, defaultStackables)
+})

package/test/unit/utils.test.mjs

@@ -0,0 +1,291 @@
+'use strict'
+
+import { test } from 'node:test'
+import { equal, deepEqual, notEqual, doesNotThrow } from 'node:assert'
+import { randomBetween, sleep, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible, isCurrentVersionSupported, minimumSupportedNodeVersions, findRuntimeConfigFile, findComposerConfigFile, convertServiceNameToPrefix, addPrefixToEnv, safeMkdir } from '../../src/utils.mjs'
+import { tmpdir } from 'os'
+import { join } from 'path'
+import esmock from 'esmock'
+import semver from 'semver'
+import { mkdir, mkdtemp, rm, writeFile } from 'fs/promises'
+
+test('getUsername from git', async () => {
+  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', async () => {
+  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', async () => {
+  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', async () => {
+  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', async () => {
+  const { getUsername } = await esmock.strict('../../src/utils.mjs', {
+    execa: {
+      execa: (command) => {
+        return ''
+      }
+    }
+  })
+  const username = await getUsername()
+  equal(username, null)
+})
+
+test('randomBetween', async () => {
+  const min = 1
+  const max = 10
+  const random = randomBetween(min, max)
+  equal(random >= min && random <= max, true)
+})
+
+test('sleep', async () => {
+  const start = Date.now()
+  await sleep(100)
+  const end = Date.now()
+  // We cannot assert the exact drift because timers
+  // are imprecise
+  equal(end - start >= 90, true)
+})
+
+test('getDependencyVersion', async () => {
+  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)
+
+  const typescriptVersion = await getDependencyVersion('typescript')
+  // We cannot assert the exact version because it changes
+  equal(semver.valid(typescriptVersion), typescriptVersion)
+  equal(semver.gt(typescriptVersion, '5.0.0'), true)
+
+  const platformaticConfig = await getDependencyVersion('@platformatic/config')
+  // We cannot assert the exact version because it changes
+  equal(semver.valid(platformaticConfig), platformaticConfig)
+  equal(semver.gt(platformaticConfig, '1.0.0'), true)
+
+  const typesVersion = await getDependencyVersion('@types/node')
+  // We cannot assert the exact version because it changes
+  equal(semver.valid(typesVersion), typesVersion)
+  equal(semver.gt(typesVersion, '20.0.0'), true)
+
+  const unkownVersion = await getDependencyVersion('@types/npm')
+  equal(unkownVersion, undefined)
+})
+
+test('findDBConfigFile', async () => {
+  const tmpDir1 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const tmpDir2 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const config = join(tmpDir1, 'platformatic.db.yml')
+  await writeFile(config, 'TEST')
+  equal(await findDBConfigFile(tmpDir1), 'platformatic.db.yml')
+  equal(await findDBConfigFile(tmpDir2), undefined)
+  await rm(tmpDir1, { recursive: true, force: true })
+  await rm(tmpDir2, { recursive: true, force: true })
+})
+
+test('findServiceConfigFile', async () => {
+  const tmpDir1 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const tmpDir2 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const config = join(tmpDir1, 'platformatic.service.toml')
+  await writeFile(config, 'TEST')
+  equal(await findServiceConfigFile(tmpDir1), 'platformatic.service.toml')
+  equal(await findServiceConfigFile(tmpDir2), undefined)
+  await rm(tmpDir1, { recursive: true, force: true })
+  await rm(tmpDir2, { recursive: true, force: true })
+})
+
+test('findComposerConfigFile', async () => {
+  const tmpDir1 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const tmpDir2 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const config = join(tmpDir1, 'platformatic.composer.yml')
+  await writeFile(config, 'TEST')
+  equal(await findComposerConfigFile(tmpDir1), 'platformatic.composer.yml')
+  equal(await findComposerConfigFile(tmpDir2), undefined)
+  await rm(tmpDir1, { recursive: true, force: true })
+  await rm(tmpDir2, { recursive: true, force: true })
+})
+
+test('findRuntimeConfigFile', async () => {
+  const tmpDir1 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const tmpDir2 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const config = join(tmpDir1, 'platformatic.runtime.yml')
+  await writeFile(config, 'TEST')
+  equal(await findRuntimeConfigFile(tmpDir1), 'platformatic.runtime.yml')
+  equal(await findRuntimeConfigFile(tmpDir2), undefined)
+  await rm(tmpDir1, { recursive: true, force: true })
+  await rm(tmpDir2, { recursive: true, force: true })
+})
+
+test('isFileAccessible', async () => {
+  const tmpDir1 = await mkdtemp(join(tmpdir(), 'test-create-platformatic-'))
+  const config = join(tmpDir1, 'platformatic.db.yml')
+  await writeFile(config, 'TEST')
+  equal(await isFileAccessible(config), true)
+  const config2 = join(tmpDir1, 'platformatic2.db.yml')
+  equal(await isFileAccessible(config2), false)
+  await rm(tmpDir1, { recursive: true, force: true })
+})
+
+test('minimumSupportedNodeVersions', async () => {
+  equal(Array.isArray(minimumSupportedNodeVersions), true)
+  notEqual(minimumSupportedNodeVersions.length, 0)
+})
+
+test('isCurrentVersionSupported', async () => {
+  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)
+  }
+})
+
+test('should convert service name to env prefix', async () => {
+  const expectations = {
+    'my-service': 'MY_SERVICE',
+    a: 'A',
+    MY_SERVICE: 'MY_SERVICE',
+    asderas123: 'ASDERAS123'
+  }
+
+  Object.entries(expectations).forEach((exp) => {
+    const converted = convertServiceNameToPrefix(exp[0])
+    equal(exp[1], converted)
+  })
+})
+
+test('should add prefix to a key/value object', async () => {
+  const prefix = 'MY_PREFIX'
+  const env = {
+    PLT_HOSTNAME: 'myhost',
+    PORT: '3042'
+  }
+  deepEqual(addPrefixToEnv(env, prefix), {
+    MY_PREFIX_PLT_HOSTNAME: 'myhost',
+    MY_PREFIX_PORT: '3042'
+  })
+})
+
+test('safeMkdir should not throw if dir already exists', async () => {
+  const tempDirectory = join(tmpdir(), 'safeMkdirTest')
+  test.after(async () => {
+    await rm(tempDirectory, { recursive: true })
+  })
+  await mkdir(tempDirectory)
+
+  doesNotThrow(async () => {
+    await safeMkdir(tempDirectory)
+  })
+})

package/help/db.txt

@@ -1,11 +0,0 @@
-Welcome to Platformatic DB Creator. 
-
-Available options are:
-  * --help - Display this message
-  * -h, --hostname <hostname>`: The hostname where Platformatic DB server will listen for connections.
-  * -p, --port <port>`: The port where Platformatic DB server will listen for connections.
-  * -db, --database <database_name>`: The name of the database to use. Default: `sqlite`. 
-  * -m, --migrations <path>`: Relative path to the migrations folder. Default: `./migrations`.
-  * -t, --types <boolean>`: Set true to enable type autogeneration. Default: `true`.
-  * -ts, --typescript <boolean>`: Set true to enable TypeScript plugins. Default: `false`.
-

package/help/help.txt

@@ -1,8 +0,0 @@
-Welcome to Platformatic DB Creator. 
-
-Available commands are:
-  * db
-  * service 
-
-Available options are:
-  * --help - Display this message

package/help/service.txt

@@ -1,7 +0,0 @@
-Welcome to Platformatic Service Creator. 
-
-Available options are:
-  * --help - Display this message
-  * -h, --hostname <hostname>`: The hostname where Platformatic DB server will listen for connections.
-  * -p, --port <port>`: The port where Platformatic DB server will listen for connections.
-