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

package/test/file-generator.test.js

@@ -3,10 +3,10 @@
 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 { readFile } = require('node:fs/promises')
 const { join } = require('node:path')
 const { tmpdir } = require('node:os')
-const { safeMkdir } = require('../lib/utils')
+const { createDirectory, safeRemove } = require('@platformatic/utils')
 
 let dirCount = 0
 describe('FileGenerator', () => {
@@ -15,14 +15,14 @@ describe('FileGenerator', () => {
     const fileObject = fg.getFileObject('sample', 'file')
     assert.strictEqual(null, fileObject)
   })
-  test('should throw if no targeDirectory is set', async (t) => {
+  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) => {
+  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' })
@@ -32,7 +32,7 @@ describe('FileGenerator', () => {
     assert.equal(fg.files.length, 1)
   })
 
-  test('should list files', async (t) => {
+  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' })
@@ -41,10 +41,10 @@ describe('FileGenerator', () => {
     assert.deepEqual(fg.listFiles(), [
       join('path', 'helloworld.txt'),
       join('path', 'foobar.txt'),
-      join('anotherpath', 'foobar.txt')
+      join('anotherpath', 'foobar.txt'),
     ])
   })
-  test('should append file content', async (t) => {
+  test('should append file content', async t => {
     const fg = new FileGenerator()
     fg.addFile({ path: 'path', file: 'helloworld.txt', contents: 'hello world' })
 
@@ -59,7 +59,7 @@ describe('FileGenerator', () => {
     assert.equal(newFileObject.contents, 'foobar')
   })
 
-  test('should reset all files', async (t) => {
+  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' })
@@ -68,13 +68,13 @@ describe('FileGenerator', () => {
     assert.equal(fg.files.length, 0)
   })
 
-  test('should write files', async (t) => {
+  test('should write files', async t => {
     const tempDir = join(tmpdir(), `plt-file-generator-test-${dirCount++}`)
     t.after(async () => {
-      await rm(tempDir, { recursive: true })
+      await safeRemove(tempDir)
     })
 
-    await safeMkdir(tempDir)
+    await createDirectory(tempDir)
     const fg = new FileGenerator()
     fg.setTargetDirectory(tempDir)
     fg.addFile({ path: 'myDir', file: 'helloworld.txt', contents: 'hello world' })
@@ -84,13 +84,13 @@ describe('FileGenerator', () => {
     assert.equal(fileContents, 'hello world')
   })
 
-  test('should not write empty files', async (t) => {
+  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 safeRemove(tempDir)
     })
 
-    await safeMkdir(tempDir)
+    await createDirectory(tempDir)
     const fg = new FileGenerator()
     fg.setTargetDirectory(tempDir)
     fg.addFile({ path: 'myDir', file: 'helloworld.txt', contents: '' })
@@ -104,13 +104,13 @@ describe('FileGenerator', () => {
     }
   })
 
-  test('should load file from filesystem', async (t) => {
+  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 safeRemove(tempDir)
     })
 
-    await safeMkdir(tempDir)
+    await createDirectory(tempDir)
     const fg = new FileGenerator()
     fg.setTargetDirectory(tempDir)
     fg.addFile({ path: 'myDir', file: 'helloworld.txt', contents: 'hello world' })
@@ -119,14 +119,14 @@ describe('FileGenerator', () => {
     fg.reset()
     const fileObject = await fg.loadFile({
       path: 'myDir',
-      file: 'helloworld.txt'
+      file: 'helloworld.txt',
     })
 
     assert.deepEqual(fileObject, {
       path: 'myDir',
       file: 'helloworld.txt',
       contents: 'hello world',
-      options: {}
+      options: {},
     })
 
     assert.equal(fg.files.length, 1)
@@ -134,7 +134,7 @@ describe('FileGenerator', () => {
       path: 'myDir',
       file: 'helloworld.txt',
       contents: 'hello world',
-      options: {}
+      options: {},
     })
   })
 })

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

@@ -1,7 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.25.0/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "rival",
-  "hotReload": true,
+  "watch": true,
   "autoload": {
     "path": "services",
     "exclude": [

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

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.25.0/service",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
   "service": {
     "openapi": true
   },

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

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v1.25.0/service",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
   "service": {
     "openapi": true
   },

package/test/helpers.js

@@ -1,9 +1,8 @@
 'use strict'
 
 const { join } = require('node:path')
-const fs = require('node:fs/promises')
-const { safeMkdir } = require('../lib/utils')
 const { MockAgent, setGlobalDispatcher } = require('undici')
+const { safeRemove, createDirectory } = require('@platformatic/utils')
 
 const mockAgent = new MockAgent()
 setGlobalDispatcher(mockAgent)
@@ -16,21 +15,17 @@ async function getTempDir (baseDir) {
     baseDir = __dirname
   }
   const dir = join(baseDir, 'tmp', `platformatic-generators-${process.pid}-${Date.now()}-${counter++}`)
-  await safeMkdir(dir)
+  await createDirectory(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(() => {}))
+    teardown(() => safeRemove(dir))
   }
   return dir
 }
@@ -41,12 +36,12 @@ function mockNpmJsRequestForPkgs (pkgs) {
       .get('https://registry.npmjs.org')
       .intercept({
         method: 'GET',
-        path: `/${pkg}`
+        path: `/${pkg}`,
       })
       .reply(200, {
         'dist-tags': {
-          latest: '1.42.0'
-        }
+          latest: '1.42.0',
+        },
       })
   }
 }
@@ -55,10 +50,10 @@ module.exports = {
     info: () => {},
     debug: () => {},
     warn: () => {},
-    error: () => {}
+    error: () => {},
   },
   getTempDir,
   moveToTmpdir,
   mockNpmJsRequestForPkgs,
-  mockAgent
+  mockAgent,
 }

package/test/stackable-generator.test.js

@@ -1,29 +1,30 @@
 'use strict'
 
-const { readFile, rm } = require('node:fs/promises')
+const { readFile } = require('node:fs/promises')
 const { test, afterEach } = require('node:test')
 const assert = require('node:assert')
 const { join } = require('node:path')
 
+const { safeRemove } = require('@platformatic/utils')
 const { fakeLogger, getTempDir } = require('./helpers')
 const { StackableGenerator } = require('../lib/stackable-generator')
 
 afterEach(async () => {
   try {
-    await rm(join(__dirname, 'tmp'), { recursive: true })
+    await safeRemove(join(__dirname, 'tmp'))
   } catch (err) {
     // do nothing
   }
 })
 
-test('should create a stackable project without typescript', async (t) => {
+test('should create a stackable project without typescript', async t => {
   const dir = await getTempDir()
   const gen = new StackableGenerator({
-    logger: fakeLogger
+    logger: fakeLogger,
   })
 
   gen.setConfig({
-    targetDirectory: dir
+    targetDirectory: dir,
   })
 
   await gen.run()
@@ -64,15 +65,15 @@ test('should create a stackable project without typescript', async (t) => {
   assert.ok(testGeneratorFile.length > 0)
 })
 
-test('should create a stackable project with typescript', async (t) => {
+test('should create a stackable project with typescript', async t => {
   const dir = await getTempDir()
   const gen = new StackableGenerator({
-    logger: fakeLogger
+    logger: fakeLogger,
   })
 
   gen.setConfig({
     targetDirectory: dir,
-    typescript: true
+    typescript: true,
   })
 
   await gen.run()

package/test/utils.test.js

@@ -9,7 +9,7 @@ const {
   envObjectToString,
   extractEnvVariablesFromText,
   getPackageConfigurationObject,
-  addPrefixToString
+  addPrefixToString,
 } = require('../lib/utils')
 const { flattenObject } = require('../lib/utils')
 const { getServiceTemplateFromSchemaUrl } = require('../lib/utils')
@@ -34,7 +34,7 @@ describe('utils', () => {
         'my-service': 'MY_SERVICE',
         a: 'A',
         MY_SERVICE: 'MY_SERVICE',
-        asderas123: 'ASDERAS123'
+        asderas123: 'ASDERAS123',
       }
 
       Object.entries(expectations).forEach((exp) => {
@@ -48,7 +48,7 @@ describe('utils', () => {
     test('should convert env object to string', async () => {
       const env = {
         FOO: 'bar',
-        DATABASE_URL: 'sqlite://./db.sqlite'
+        DATABASE_URL: 'sqlite://./db.sqlite',
       }
 
       assert.equal(envObjectToString(env), `FOO=bar${EOL}DATABASE_URL=sqlite://./db.sqlite`)
@@ -86,39 +86,39 @@ describe('utils', () => {
       {
         path: 'prefix',
         value: '/foo',
-        type: 'string'
+        type: 'string',
       },
       {
         path: 'foo.fooOption1',
         value: 'value1',
-        type: 'string'
+        type: 'string',
       },
       {
         path: 'foo.fooOption2',
         value: 'value2',
-        type: 'string'
+        type: 'string',
       },
       {
         path: 'foo.fooOption3',
         value: 'value3',
         type: 'string',
-        name: 'THE_FOO_OPTION_3'
+        name: 'THE_FOO_OPTION_3',
       },
       {
         path: 'foobar',
         value: '123',
-        type: 'number'
+        type: 'number',
       },
       {
         path: 'boolean.truthy',
         value: 'true',
-        type: 'boolean'
+        type: 'boolean',
       },
       {
         path: 'boolean.falsey',
         value: 'false',
-        type: 'boolean'
-      }
+        type: 'boolean',
+      },
     ]
     const output = getPackageConfigurationObject(input)
     assert.deepEqual(output.config, {
@@ -126,17 +126,17 @@ describe('utils', () => {
       foo: {
         fooOption1: 'value1',
         fooOption2: 'value2',
-        fooOption3: '{THE_FOO_OPTION_3}'
+        fooOption3: '{THE_FOO_OPTION_3}',
       },
       foobar: 123,
       boolean: {
         truthy: true,
-        falsey: false
-      }
+        falsey: false,
+      },
     })
 
     assert.deepEqual(output.env, {
-      THE_FOO_OPTION_3: 'value3'
+      THE_FOO_OPTION_3: 'value3',
     })
 
     // should throw
@@ -145,8 +145,8 @@ describe('utils', () => {
         {
           path: 'wrong',
           type: 'object',
-          value: {}
-        }
+          value: {},
+        },
       ])
       assert.fail()
     } catch (err) {
@@ -172,12 +172,12 @@ describe('utils', () => {
           credentials: {
             client: {
               id: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_ID}',
-              secret: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CREDENTIALS_CLIENT_SECRET}'
-            }
+              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}'
-        }
+          callbackUri: '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CALLBACK_URI}',
+        },
       }
       const expected = {
         name: '@fastify/oauth2',
@@ -185,7 +185,7 @@ describe('utils', () => {
         '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}'
+        'options.callbackUri': '{PLT_RIVAL_FST_PLUGIN_OAUTH2_CALLBACK_URI}',
       }
       assert.deepEqual(flattenObject(packageObject), expected)
     })
@@ -193,9 +193,9 @@ describe('utils', () => {
 
   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'
+      const composerSchema = 'https://schemas.platformatic.dev/@platformatic/composer/1.52.0.json'
+      const serviceSchema = 'https://schemas.platformatic.dev/@platformatic/service/1.52.0.json'
+      const dbSchema = 'https://schemas.platformatic.dev/@platformatic/db/1.52.0.json'
 
       assert.equal(getServiceTemplateFromSchemaUrl(composerSchema), '@platformatic/composer')
       assert.equal(getServiceTemplateFromSchemaUrl(serviceSchema), '@platformatic/service')
@@ -209,12 +209,12 @@ describe('utils', () => {
         '',
         '# this is a comment that will be not parsed',
         'MY_VAR=value',
-        'PLT_SERVICE_NAME_FOOBAR=foobar'
+        'PLT_SERVICE_NAME_FOOBAR=foobar',
       ]
 
       const expected = {
         MY_VAR: 'value',
-        PLT_SERVICE_NAME_FOOBAR: 'foobar'
+        PLT_SERVICE_NAME_FOOBAR: 'foobar',
       }
 
       assert.deepEqual(envStringToObject(template.join(EOL)), expected)