@platformatic/generators 2.0.0-alpha.2 → 2.0.0-alpha.21

package/test/file-generator.test.js

@@ -1,140 +0,0 @@
-'use strict'
-
-const { test, describe } = require('node:test')
-const assert = require('node:assert')
-const { FileGenerator } = require('../lib/file-generator')
-const { rm, readFile } = require('node:fs/promises')
-const { join } = require('node:path')
-const { tmpdir } = require('node:os')
-const { safeMkdir } = require('../lib/utils')
-
-let dirCount = 0
-describe('FileGenerator', () => {
-  test('should return null if file is not found', async () => {
-    const fg = new FileGenerator()
-    const fileObject = fg.getFileObject('sample', 'file')
-    assert.strictEqual(null, fileObject)
-  })
-  test('should throw if no targeDirectory is set', async (t) => {
-    const fg = new FileGenerator()
-    assert.rejects(async () => {
-      await fg.writeFiles()
-    })
-  })
-
-  test('should replace a file with same name and path', async (t) => {
-    const fg = new FileGenerator()
-    fg.addFile({ path: 'path', file: 'file', contents: 'hello world' })
-    fg.addFile({ path: 'path', file: 'file', contents: 'foobar' })
-
-    const fileObject = fg.getFileObject('file', 'path')
-    assert.equal(fileObject.contents, 'foobar')
-    assert.equal(fg.files.length, 1)
-  })
-
-  test('should list files', async (t) => {
-    const fg = new FileGenerator()
-    fg.addFile({ path: 'path', file: 'helloworld.txt', contents: 'hello world' })
-    fg.addFile({ path: 'path', file: 'foobar.txt', contents: 'foobar' })
-    fg.addFile({ path: '/anotherpath', file: 'foobar.txt', contents: 'foobar' })
-
-    assert.deepEqual(fg.listFiles(), [
-      join('path', 'helloworld.txt'),
-      join('path', 'foobar.txt'),
-      join('anotherpath', 'foobar.txt')
-    ])
-  })
-  test('should append file content', async (t) => {
-    const fg = new FileGenerator()
-    fg.addFile({ path: 'path', file: 'helloworld.txt', contents: 'hello world' })
-
-    fg.appendfile({ path: '/path', file: 'helloworld.txt', contents: 'Welcome to plaftormatic' })
-
-    const fileObject = fg.getFileObject('helloworld.txt', 'path')
-    assert.equal(fileObject.contents, 'hello world\nWelcome to plaftormatic')
-
-    // new file
-    fg.appendfile({ path: '/path', file: 'foobar.txt', contents: 'foobar' })
-    const newFileObject = fg.getFileObject('foobar.txt', 'path')
-    assert.equal(newFileObject.contents, 'foobar')
-  })
-
-  test('should reset all files', async (t) => {
-    const fg = new FileGenerator()
-    fg.addFile({ path: 'path', file: 'file', contents: 'hello world' })
-    fg.addFile({ path: 'path', file: 'file', contents: 'foobar' })
-
-    fg.reset()
-    assert.equal(fg.files.length, 0)
-  })
-
-  test('should write files', async (t) => {
-    const tempDir = join(tmpdir(), `plt-file-generator-test-${dirCount++}`)
-    t.after(async () => {
-      await rm(tempDir, { recursive: true })
-    })
-
-    await safeMkdir(tempDir)
-    const fg = new FileGenerator()
-    fg.setTargetDirectory(tempDir)
-    fg.addFile({ path: 'myDir', file: 'helloworld.txt', contents: 'hello world' })
-
-    await fg.writeFiles()
-    const fileContents = await readFile(join(tempDir, 'myDir', 'helloworld.txt'), 'utf8')
-    assert.equal(fileContents, 'hello world')
-  })
-
-  test('should not write empty files', async (t) => {
-    const tempDir = join(tmpdir(), `plt-file-generator-test-${dirCount++}`)
-    t.after(async () => {
-      await rm(tempDir, { recursive: true })
-    })
-
-    await safeMkdir(tempDir)
-    const fg = new FileGenerator()
-    fg.setTargetDirectory(tempDir)
-    fg.addFile({ path: 'myDir', file: 'helloworld.txt', contents: '' })
-
-    await fg.writeFiles()
-    try {
-      await readFile(join(tempDir, 'myDir', 'helloworld.txt'), 'utf8')
-      assert.fail()
-    } catch (err) {
-      assert.equal(err.code, 'ENOENT')
-    }
-  })
-
-  test('should load file from filesystem', async (t) => {
-    const tempDir = join(tmpdir(), `plt-file-generator-test-${dirCount++}`)
-    t.after(async () => {
-      await rm(tempDir, { recursive: true })
-    })
-
-    await safeMkdir(tempDir)
-    const fg = new FileGenerator()
-    fg.setTargetDirectory(tempDir)
-    fg.addFile({ path: 'myDir', file: 'helloworld.txt', contents: 'hello world' })
-    await fg.writeFiles()
-
-    fg.reset()
-    const fileObject = await fg.loadFile({
-      path: 'myDir',
-      file: 'helloworld.txt'
-    })
-
-    assert.deepEqual(fileObject, {
-      path: 'myDir',
-      file: 'helloworld.txt',
-      contents: 'hello world',
-      options: {}
-    })
-
-    assert.equal(fg.files.length, 1)
-    assert.deepEqual(fg.files[0], {
-      path: 'myDir',
-      file: 'helloworld.txt',
-      contents: 'hello world',
-      options: {}
-    })
-  })
-})

package/test/fixtures/sample-runtime/.env

@@ -1,9 +0,0 @@
-PLT_SERVER_HOSTNAME=0.0.0.0
-PORT=3042
-PLT_SERVER_LOGGER_LEVEL=info
-PLT_RIVAL_TYPESCRIPT=true
-PLT_RIVAL_FST_PLUGIN_OAUTH2_NAME=googleOAuth2
-PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_ID=sample_client_id
-PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_SECRET=sample_client_secret
-PLT_RIVAL_FST_PLUGIN_OAUTH2_REDIRECT_PATH=/login/google
-PLT_RIVAL_FST_PLUGIN_OAUTH2_CALLBACK_URI=http://localhost:3000/login/google/callback

package/test/fixtures/sample-runtime/platformatic.json

@@ -1,18 +0,0 @@
-{
-  "$schema": "https://platformatic.dev/schemas/v1.25.0/runtime",
-  "entrypoint": "rival",
-  "hotReload": true,
-  "autoload": {
-    "path": "services",
-    "exclude": [
-      "docs"
-    ]
-  },
-  "server": {
-    "hostname": "{PLT_SERVER_HOSTNAME}",
-    "port": "{PORT}",
-    "logger": {
-      "level": "{PLT_SERVER_LOGGER_LEVEL}"
-    }
-  }
-}

package/test/fixtures/sample-runtime/services/no-plugin/platformatic.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "https://platformatic.dev/schemas/v1.25.0/service",
-  "service": {
-    "openapi": true
-  },
-  "watch": true
-}

package/test/fixtures/sample-runtime/services/rival/platformatic.json

@@ -1,33 +0,0 @@
-{
-  "$schema": "https://platformatic.dev/schemas/v1.25.0/service",
-  "service": {
-    "openapi": true
-  },
-  "watch": true,
-  "plugins": {
-    "paths": [
-      {
-        "path": "./plugins",
-        "encapsulate": false
-      },
-      "./routes"
-    ],
-    "typescript": "{PLT_RIVAL_TYPESCRIPT}",
-    "packages": [
-      {
-        "name": "@fastify/oauth2",
-        "options": {
-          "name": "{PLT_RIVAL_FST_PLUGIN_OAUTH2_NAME}",
-          "credentials": {
-            "client": {
-              "id": "{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_ID}",
-              "secret": "{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_SECRET}"
-            }
-          },
-          "startRedirectPath": "{PLT_RIVAL_FST_PLUGIN_OAUTH2_REDIRECT_PATH}",
-          "callbackUri": "{PLT_RIVAL_FST_PLUGIN_OAUTH2_CALLBACK_URI}"
-        }
-      }
-    ]
-  }
-}

package/test/helpers.js

@@ -1,64 +0,0 @@
-'use strict'
-
-const { join } = require('node:path')
-const fs = require('node:fs/promises')
-const { safeMkdir } = require('../lib/utils')
-const { MockAgent, setGlobalDispatcher } = require('undici')
-
-const mockAgent = new MockAgent()
-setGlobalDispatcher(mockAgent)
-mockAgent.disableNetConnect()
-
-let counter = 0
-
-async function getTempDir (baseDir) {
-  if (baseDir === undefined) {
-    baseDir = __dirname
-  }
-  const dir = join(baseDir, 'tmp', `platformatic-generators-${process.pid}-${Date.now()}-${counter++}`)
-  await safeMkdir(dir)
-  return dir
-}
-async function moveToTmpdir (teardown) {
-  const cwd = process.cwd()
-  // const tmp = join(__dirname, 'tmp')
-  // try {
-  //   await fs.mkdir(tmp)
-  // } catch {
-  // }
-  const dir = await getTempDir()
-  process.chdir(dir)
-  teardown(() => process.chdir(cwd))
-  if (!process.env.SKIP_RM_TMP) {
-    teardown(() => fs.rm(dir, { recursive: true }).catch(() => {}))
-  }
-  return dir
-}
-
-function mockNpmJsRequestForPkgs (pkgs) {
-  for (const pkg of pkgs) {
-    mockAgent
-      .get('https://registry.npmjs.org')
-      .intercept({
-        method: 'GET',
-        path: `/${pkg}`
-      })
-      .reply(200, {
-        'dist-tags': {
-          latest: '1.42.0'
-        }
-      })
-  }
-}
-module.exports = {
-  fakeLogger: {
-    info: () => {},
-    debug: () => {},
-    warn: () => {},
-    error: () => {}
-  },
-  getTempDir,
-  moveToTmpdir,
-  mockNpmJsRequestForPkgs,
-  mockAgent
-}

package/test/stackable-generator.test.js

@@ -1,114 +0,0 @@
-'use strict'
-
-const { readFile, rm } = require('node:fs/promises')
-const { test, afterEach } = require('node:test')
-const assert = require('node:assert')
-const { join } = require('node:path')
-
-const { fakeLogger, getTempDir } = require('./helpers')
-const { StackableGenerator } = require('../lib/stackable-generator')
-
-afterEach(async () => {
-  try {
-    await rm(join(__dirname, 'tmp'), { recursive: true })
-  } catch (err) {
-    // do nothing
-  }
-})
-
-test('should create a stackable project without typescript', async (t) => {
-  const dir = await getTempDir()
-  const gen = new StackableGenerator({
-    logger: fakeLogger
-  })
-
-  gen.setConfig({
-    targetDirectory: dir
-  })
-
-  await gen.run()
-  // check files are created
-  const packageJson = JSON.parse(await readFile(join(dir, 'package.json'), 'utf8'))
-  assert.ok(packageJson.scripts)
-  assert.ok(packageJson.dependencies)
-  assert.ok(packageJson.engines)
-
-  const indexFile = await readFile(join(dir, 'index.js'), 'utf8')
-  assert.ok(indexFile.length > 0)
-
-  const indexTypesFile = await readFile(join(dir, 'index.d.ts'), 'utf8')
-  assert.ok(indexTypesFile.length > 0)
-
-  const schemaFile = await readFile(join(dir, 'lib', 'schema.js'), 'utf8')
-  assert.ok(schemaFile.length > 0)
-
-  const generatorFile = await readFile(join(dir, 'lib', 'generator.js'), 'utf8')
-  assert.ok(generatorFile.length > 0)
-
-  const startCommandFile = await readFile(join(dir, 'cli', 'start.js'), 'utf8')
-  assert.ok(startCommandFile.length > 0)
-
-  const createCommandFile = await readFile(join(dir, 'cli', 'create.js'), 'utf8')
-  assert.ok(createCommandFile.length > 0)
-
-  const gitignore = await readFile(join(dir, '.gitignore'), 'utf8')
-  assert.ok(gitignore.length > 0)
-
-  const testIndexFile = await readFile(join(dir, 'test', 'index.test.js'), 'utf8')
-  assert.ok(testIndexFile.length > 0)
-
-  const testSchemaFile = await readFile(join(dir, 'test', 'schema.test.js'), 'utf8')
-  assert.ok(testSchemaFile.length > 0)
-
-  const testGeneratorFile = await readFile(join(dir, 'test', 'generator.test.js'), 'utf8')
-  assert.ok(testGeneratorFile.length > 0)
-})
-
-test('should create a stackable project with typescript', async (t) => {
-  const dir = await getTempDir()
-  const gen = new StackableGenerator({
-    logger: fakeLogger
-  })
-
-  gen.setConfig({
-    targetDirectory: dir,
-    typescript: true
-  })
-
-  await gen.run()
-  // check files are created
-  const packageJson = JSON.parse(await readFile(join(dir, 'package.json'), 'utf8'))
-  assert.ok(packageJson.scripts)
-  assert.ok(packageJson.dependencies)
-  assert.ok(packageJson.engines)
-
-  const indexFile = await readFile(join(dir, 'index.ts'), 'utf8')
-  assert.ok(indexFile.length > 0)
-
-  const indexTypesFile = await readFile(join(dir, 'index.d.ts'), 'utf8')
-  assert.ok(indexTypesFile.length > 0)
-
-  const schemaFile = await readFile(join(dir, 'lib', 'schema.ts'), 'utf8')
-  assert.ok(schemaFile.length > 0)
-
-  const generatorFile = await readFile(join(dir, 'lib', 'generator.ts'), 'utf8')
-  assert.ok(generatorFile.length > 0)
-
-  const startCommandFile = await readFile(join(dir, 'cli', 'start.ts'), 'utf8')
-  assert.ok(startCommandFile.length > 0)
-
-  const createCommandFile = await readFile(join(dir, 'cli', 'create.ts'), 'utf8')
-  assert.ok(createCommandFile.length > 0)
-
-  const gitignore = await readFile(join(dir, '.gitignore'), 'utf8')
-  assert.ok(gitignore.length > 0)
-
-  const testIndexFile = await readFile(join(dir, 'test', 'index.test.ts'), 'utf8')
-  assert.ok(testIndexFile.length > 0)
-
-  const testSchemaFile = await readFile(join(dir, 'test', 'schema.test.ts'), 'utf8')
-  assert.ok(testSchemaFile.length > 0)
-
-  const testGeneratorFile = await readFile(join(dir, 'test', 'generator.test.ts'), 'utf8')
-  assert.ok(testGeneratorFile.length > 0)
-})

package/test/utils.test.js

@@ -1,223 +0,0 @@
-'use strict'
-
-const { test, describe } = require('node:test')
-const { EOL } = require('node:os')
-const assert = require('node:assert')
-const {
-  stripVersion,
-  convertServiceNameToPrefix,
-  envObjectToString,
-  extractEnvVariablesFromText,
-  getPackageConfigurationObject,
-  addPrefixToString
-} = require('../lib/utils')
-const { flattenObject } = require('../lib/utils')
-const { getServiceTemplateFromSchemaUrl } = require('../lib/utils')
-const { envStringToObject } = require('../lib/utils')
-
-describe('utils', () => {
-  describe('stripVersion', async () => {
-    test('should return the same string if not semver', async (t) => {
-      assert.equal('no-version', stripVersion('no-version'))
-    })
-
-    test('should match semver', async (t) => {
-      assert.equal('1.2.3', stripVersion('v1.2.3'))
-      assert.equal('1.2.3', stripVersion('~1.2.3'))
-      assert.equal('1.2.3', stripVersion('^1.2.3'))
-    })
-  })
-
-  describe('convertServiceNameToPrefix', () => {
-    test('should convert service name to env prefix', async (t) => {
-      const expectations = {
-        'my-service': 'MY_SERVICE',
-        a: 'A',
-        MY_SERVICE: 'MY_SERVICE',
-        asderas123: 'ASDERAS123'
-      }
-
-      Object.entries(expectations).forEach((exp) => {
-        const converted = convertServiceNameToPrefix(exp[0])
-        assert.equal(exp[1], converted)
-      })
-    })
-  })
-
-  describe('envObjectToString', () => {
-    test('should convert env object to string', async () => {
-      const env = {
-        FOO: 'bar',
-        DATABASE_URL: 'sqlite://./db.sqlite'
-      }
-
-      assert.equal(envObjectToString(env), `FOO=bar${EOL}DATABASE_URL=sqlite://./db.sqlite`)
-    })
-  })
-
-  describe('extractEnvVariablesFromText', () => {
-    test('should extract env vars from text', async () => {
-      const text = `
-      This is a sample text where an {ENV_VAR} should be detected
-      
-      DATABASE_URL={DATABASE_URL}
-      `
-      const env = extractEnvVariablesFromText(text)
-      assert.deepEqual(env, ['ENV_VAR', 'DATABASE_URL'])
-    })
-
-    test('should not extract {} as empty env var', async () => {
-      const text = `This is a sample text where an {ENV_VAR} should be detected
-        but this {} should not be parsed
-      `
-      const env = extractEnvVariablesFromText(text)
-      assert.deepEqual(env, ['ENV_VAR'])
-    })
-
-    test('should return empty array if no env vars are detected', async () => {
-      const text = 'This is a sample text without any env var. This {} should not be parsed'
-      const env = extractEnvVariablesFromText(text)
-      assert.deepEqual(env, [])
-    })
-  })
-
-  describe('getPackageConfigurationObject', async () => {
-    const input = [
-      {
-        path: 'prefix',
-        value: '/foo',
-        type: 'string'
-      },
-      {
-        path: 'foo.fooOption1',
-        value: 'value1',
-        type: 'string'
-      },
-      {
-        path: 'foo.fooOption2',
-        value: 'value2',
-        type: 'string'
-      },
-      {
-        path: 'foo.fooOption3',
-        value: 'value3',
-        type: 'string',
-        name: 'THE_FOO_OPTION_3'
-      },
-      {
-        path: 'foobar',
-        value: '123',
-        type: 'number'
-      },
-      {
-        path: 'boolean.truthy',
-        value: 'true',
-        type: 'boolean'
-      },
-      {
-        path: 'boolean.falsey',
-        value: 'false',
-        type: 'boolean'
-      }
-    ]
-    const output = getPackageConfigurationObject(input)
-    assert.deepEqual(output.config, {
-      prefix: '/foo',
-      foo: {
-        fooOption1: 'value1',
-        fooOption2: 'value2',
-        fooOption3: '{THE_FOO_OPTION_3}'
-      },
-      foobar: 123,
-      boolean: {
-        truthy: true,
-        falsey: false
-      }
-    })
-
-    assert.deepEqual(output.env, {
-      THE_FOO_OPTION_3: 'value3'
-    })
-
-    // should throw
-    try {
-      getPackageConfigurationObject([
-        {
-          path: 'wrong',
-          type: 'object',
-          value: {}
-        }
-      ])
-      assert.fail()
-    } catch (err) {
-      assert.equal(err.code, 'PLT_GEN_WRONG_TYPE')
-      assert.equal(err.message, "Invalid value type. Accepted values are 'string', 'number' and 'boolean', found 'object'.")
-    }
-  })
-
-  describe('addPrefixToString', () => {
-    test('should add prefix to string', async () => {
-      assert.equal(addPrefixToString('PLT_SERVICE_FOO', 'SERVICE'), 'PLT_SERVICE_FOO')
-      assert.equal(addPrefixToString('FOO', 'SERVICE'), 'PLT_SERVICE_FOO')
-      assert.equal(addPrefixToString('FOO', ''), 'FOO')
-    })
-  })
-
-  describe('flattenObject', () => {
-    test('should return a single depth object', () => {
-      const packageObject = {
-        name: '@fastify/oauth2',
-        options: {
-          name: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_NAME}',
-          credentials: {
-            client: {
-              id: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_ID}',
-              secret: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_SECRET}'
-            }
-          },
-          startRedirectPath: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_REDIRECT_PATH}',
-          callbackUri: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CALLBACK_URI}'
-        }
-      }
-      const expected = {
-        name: '@fastify/oauth2',
-        'options.name': '{PLT_RIVAL_FST_PLUGIN_OAUTH2_NAME}',
-        'options.credentials.client.id': '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_ID}',
-        'options.credentials.client.secret': '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_SECRET}',
-        'options.startRedirectPath': '{PLT_RIVAL_FST_PLUGIN_OAUTH2_REDIRECT_PATH}',
-        'options.callbackUri': '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CALLBACK_URI}'
-      }
-      assert.deepEqual(flattenObject(packageObject), expected)
-    })
-  })
-
-  describe('getServiceTemplateFromSchemaUrl', () => {
-    test('should get the right template name from schema url', () => {
-      const composerSchema = 'https://platformatic.dev/schemas/v1.25.0/composer'
-      const serviceSchema = 'https://platformatic.dev/schemas/v1.25.0/service'
-      const dbSchema = 'https://platformatic.dev/schemas/v1.25.0/db'
-
-      assert.equal(getServiceTemplateFromSchemaUrl(composerSchema), '@platformatic/composer')
-      assert.equal(getServiceTemplateFromSchemaUrl(serviceSchema), '@platformatic/service')
-      assert.equal(getServiceTemplateFromSchemaUrl(dbSchema), '@platformatic/db')
-    })
-  })
-
-  describe('envStringToObject', () => {
-    test('should convert .env-like string to object', () => {
-      const template = [
-        '',
-        '# this is a comment that will be not parsed',
-        'MY_VAR=value',
-        'PLT_SERVICE_NAME_FOOBAR=foobar'
-      ]
-
-      const expected = {
-        MY_VAR: 'value',
-        PLT_SERVICE_NAME_FOOBAR: 'foobar'
-      }
-
-      assert.deepEqual(envStringToObject(template.join(EOL)), expected)
-    })
-  })
-})