Moved package.json to root.

Signed-off-by: dblock <dblock@amazon.com>

.github/workflows/build.yml

@@ -21,11 +21,10 @@ jobs:
           node-version: '20'
 
       - name: Build
-        working-directory: ./tools
         run: |-
-          mkdir -p ../build
+          mkdir -p ./build
           npm install
-          npm run merge -- --source ../spec --output ../build/opensearch-openapi.yaml
+          npm run merge -- --source ./spec --output ./build/opensearch-openapi.yaml
 
       - name: Extract Branch Name
         id: branch

.github/workflows/coverage-gather.yml

@@ -15,11 +15,10 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v2
       - name: Build Spec
-        working-directory: ./tools
         run: |-
-          mkdir -p ../build
+          mkdir -p ./build
           npm install
-          npm run merge -- --source ../spec --output ../build/opensearch-openapi.yaml
+          npm run merge -- --source ./spec --output ./build/opensearch-openapi.yaml
       - name: Build and Run Docker Container
         run: |
           docker build coverage --tag opensearch-with-api-plugin

.github/workflows/links.yml

@@ -14,4 +14,4 @@ jobs:
         uses: lycheeverse/lychee-action@v1
         with:
           fail: true
-          args: --base . --verbose --no-progress './**/*.yaml' './**/*.yml' './**/*.md' './**/*.json'  './**/*.ts' --exclude-path ./tools/package-lock.json
+          args: --base . --verbose --no-progress './**/*.yaml' './**/*.yml' './**/*.md' './**/*.json'  './**/*.ts' --exclude-path ./package-lock.json

.github/workflows/lint.yml

@@ -25,4 +25,4 @@ jobs:
           node-version: 20.10.0
       - run: npm install
       - run: |
-          npm run lint:spec -- --source ../spec
+          npm run lint:spec -- --source ./spec

_plugins/openapi.rb

@@ -2,10 +2,8 @@ module OpenAPI
   def self.generate(_site, _payload)
     return if @generated
 
-    Dir.chdir('tools') do
-      system 'npm install'
-      system 'npm run merge -- --source ../spec --output ../_site/opensearch-openapi.yaml'
-    end
+    system 'npm install'
+    system 'npm run merge -- --source ./spec --output ./_site/opensearch-openapi.yaml'
 
     @generated = true
   end

tools/package.json → package.json

@@ -5,8 +5,8 @@
   "author": "opensearch-project",
   "license": "Apache-2.0",
   "scripts": {
-    "merge": "ts-node merger/merge.ts",
-    "lint:spec": "ts-node linter/lint.ts",
+    "merge": "ts-node tools/merger/merge.ts",
+    "lint:spec": "ts-node tools/linter/lint.ts",
     "lint": "eslint .",
     "test": "jest"
   },

spec/_info.yaml

@@ -1,4 +1,4 @@
-$schema: ../json_schemas/_info.schema.yaml
+$schema: ./json_schemas/_info.schema.yaml
 
 title: OpenSearch API Specification
 version: 1.0.0

spec/_superseded_operations.yaml

@@ -1,4 +1,4 @@
-$schema: ../json_schemas/_superseded_operations.schema.yaml
+$schema: ./json_schemas/_superseded_operations.schema.yaml
 
 /_opendistro/_alerting/destinations:
   superseded_by: /_plugins/_alerting/destinations

tools/test/linter/InfoFile.test.ts → tests/tools/linter/InfoFile.test.ts

@@ -1,7 +1,7 @@
-import InfoFile from '../../linter/components/InfoFile'
+import InfoFile from '../../../tools/linter/components/InfoFile'
 
 test('validate()', () => {
-  const validator = new InfoFile('./test/linter/fixtures/_info.yaml')
+  const validator = new InfoFile('./tests/tools/linter/fixtures/_info.yaml')
   expect(validator.validate()).toEqual([
     {
       file: 'fixtures/_info.yaml',

tools/test/linter/InlineObjectSchemaValidator.test.ts → tests/tools/linter/InlineObjectSchemaValidator.test.ts

@@ -1,9 +1,9 @@
-import SchemasFolder from '../../linter/components/SchemasFolder'
-import NamespacesFolder from '../../linter/components/NamespacesFolder'
-import InlineObjectSchemaValidator from '../../linter/InlineObjectSchemaValidator'
+import SchemasFolder from '../../../tools/linter/components/SchemasFolder'
+import NamespacesFolder from '../../../tools/linter/components/NamespacesFolder'
+import InlineObjectSchemaValidator from '../../../tools/linter/InlineObjectSchemaValidator'
 
 test('validate()', () => {
-  const root_folder = './test/linter/fixtures/inline_object_schema_validator'
+  const root_folder = './tests/tools/linter/fixtures/inline_object_schema_validator'
   const namespaces_folder = new NamespacesFolder(`${root_folder}/namespaces`)
   const schemas_folder = new SchemasFolder(`${root_folder}/schemas`)
   const validator = new InlineObjectSchemaValidator(namespaces_folder, schemas_folder)

tools/test/linter/NamespacesFolder.test.ts → tests/tools/linter/NamespacesFolder.test.ts

@@ -1,7 +1,7 @@
-import NamespacesFolder from '../../linter/components/NamespacesFolder'
+import NamespacesFolder from '../../../tools/linter/components/NamespacesFolder'
 
 test('validate() - When there invalid files', () => {
-  const validator = new NamespacesFolder('./test/linter/fixtures/folder_validators/namespaces/invalid_files')
+  const validator = new NamespacesFolder('./tests/tools/linter/fixtures/folder_validators/namespaces/invalid_files')
   expect(validator.validate()).toEqual([
     {
       file: 'invalid_files/indices.txt',
@@ -37,7 +37,7 @@ test('validate() - When there invalid files', () => {
 })
 
 test('validate() - When the files are valid but the folder is not', () => {
-  const validator = new NamespacesFolder('./test/linter/fixtures/folder_validators/namespaces/invalid_folder')
+  const validator = new NamespacesFolder('./tests/tools/linter/fixtures/folder_validators/namespaces/invalid_folder')
   expect(validator.validate()).toEqual([
     {
       file: 'invalid_folder/',

tools/test/linter/SchemaRefsValidator.test.ts → tests/tools/linter/SchemaRefsValidator.test.ts

@@ -1,9 +1,9 @@
-import SchemasFolder from '../../linter/components/SchemasFolder'
-import NamespacesFolder from '../../linter/components/NamespacesFolder'
-import SchemaRefsValidator from '../../linter/SchemaRefsValidator'
+import SchemasFolder from '../../../tools/linter/components/SchemasFolder'
+import NamespacesFolder from '../../../tools/linter/components/NamespacesFolder'
+import SchemaRefsValidator from '../../../tools/linter/SchemaRefsValidator'
 
 test('validate()', () => {
-  const root_folder = './test/linter/fixtures/schema_refs_validator'
+  const root_folder = './tests/tools/linter/fixtures/schema_refs_validator'
   const namespaces_folder = new NamespacesFolder(`${root_folder}/namespaces`)
   const schemas_folder = new SchemasFolder(`${root_folder}/schemas`)
   const validator = new SchemaRefsValidator(namespaces_folder, schemas_folder)

tools/test/linter/SpecValidator.test.ts → tests/tools/linter/SpecValidator.test.ts

@@ -1,7 +1,7 @@
-import SpecValidator from '../../linter/SpecValidator'
+import SpecValidator from '../../../tools/linter/SpecValidator'
 
 test('validate()', () => {
-  const validator = new SpecValidator('./test/linter/fixtures/empty')
+  const validator = new SpecValidator('./tests/tools/linter/fixtures/empty')
   expect(validator.validate()).toEqual([])
 
   validator.namespaces_folder.validate = jest.fn().mockReturnValue([{ file: 'namespaces/', message: 'namespace error' }])

tests/tools/linter/SupersededOperationsFile.test.ts

@@ -0,0 +1,11 @@
+import SupersededOperationsFile from '../../../tools/linter/components/SupersededOperationsFile'
+
+test('validate()', () => {
+  const validator = new SupersededOperationsFile('./tests/tools/linter/fixtures/_superseded_operations.yaml')
+  expect(validator.validate()).toEqual([
+    {
+      file: 'fixtures/_superseded_operations.yaml',
+      message: "File content does not match JSON schema found in './json_schemas/_superseded_operations.schema.yaml':\n [\n  {\n    \"instancePath\": \"/~1hello~1world/operations/1\",\n    \"schemaPath\": \"#/patternProperties/%5E~1/properties/operations/items/enum\",\n    \"keyword\": \"enum\",\n    \"params\": {\n      \"allowedValues\": [\n        \"GET\",\n        \"POST\",\n        \"PUT\",\n        \"DELETE\",\n        \"HEAD\",\n        \"OPTIONS\",\n        \"PATCH\"\n      ]\n    },\n    \"message\": \"must be equal to one of the allowed values\"\n  }\n]"
+    }
+  ])
+})

tools/test/linter/factories/namespace_file.ts → tests/tools/linter/factories/namespace_file.ts

@@ -1,9 +1,9 @@
-import NamespaceFile from '../../../linter/components/NamespaceFile'
+import NamespaceFile from '../../../../tools/linter/components/NamespaceFile'
 import { type OpenAPIV3 } from 'openapi-types'
 import { mocked_operation_group } from './operation_group'
 
 export function namespace_file (fixture_file: string): NamespaceFile {
-  return new NamespaceFile(`./test/linter/fixtures/file_validators/namespaces/${fixture_file}`)
+  return new NamespaceFile(`./tests/tools/linter/fixtures/file_validators/namespaces/${fixture_file}`)
 }
 
 interface MockedReturnedValues {

tools/test/linter/factories/operation.ts → tests/tools/linter/factories/operation.ts

@@ -1,5 +1,5 @@
-import Operation from '../../../linter/components/Operation'
-import { type OperationSpec } from '../../../types'
+import Operation from '../../../../tools/linter/components/Operation'
+import { type OperationSpec } from '../../../../tools/types'
 
 export function operation (spec: Record<string, any>, file_name = 'indices.yaml'): Operation {
   return new Operation(`namespaces/${file_name}`, '/{index}/something/{abc_xyz}', 'post', spec as OperationSpec)

tools/test/linter/factories/operation_group.ts → tests/tools/linter/factories/operation_group.ts

@@ -1,4 +1,4 @@
-import OperationGroup from '../../../linter/components/OperationGroup'
+import OperationGroup from '../../../../tools/linter/components/OperationGroup'
 import { operation, mocked_operation } from './operation'
 
 export function operation_group (operation_specs: Array<Record<string, any>>): OperationGroup {

tools/test/linter/factories/schema.ts → tests/tools/linter/factories/schema.ts

@@ -1,4 +1,4 @@
-import Schema from '../../../linter/components/Schema'
+import Schema from '../../../../tools/linter/components/Schema'
 import { type OpenAPIV3 } from 'openapi-types'
 
 export function schema (name: string, spec: Record<string, any> = {}): Schema {

tools/test/linter/factories/schema_file.ts → tests/tools/linter/factories/schema_file.ts

@@ -1,8 +1,8 @@
 import { mocked_schema } from './schema'
-import SchemaFile from '../../../linter/components/SchemaFile'
+import SchemaFile from '../../../../tools/linter/components/SchemaFile'
 
 export function schema_file (fixture: string): SchemaFile {
-  return new SchemaFile(`./test/linter/fixtures/file_validators/schemas/${fixture}`)
+  return new SchemaFile(`./tests/tools/linter/fixtures/file_validators/schemas/${fixture}`)
 }
 
 interface MockedReturnedValues {

tools/test/linter/fixtures/_superseded_operations.yaml → tests/tools/linter/fixtures/_superseded_operations.yaml

@@ -1,4 +1,4 @@
-$schema: ../json_schemas/_superseded_operations.schema.yaml
+$schema: ./json_schemas/_superseded_operations.schema.yaml
 
 /hello/world:
   superseded_by: /goodbye/world

tests/tools/linter/fixtures/empty/_info.yaml

@@ -0,0 +1,4 @@
+$schema: ./json_schemas/_info.schema.yaml
+
+title: ''
+version: ''

tests/tools/linter/fixtures/empty/_superseded_operations.yaml

@@ -0,0 +1 @@
+$schema: ./json_schemas/_superseded_operations.schema.yaml

tests/tools/merger/OpenApiMerger.test.ts

@@ -0,0 +1,10 @@
+import OpenApiMerger from '../../../tools/merger/OpenApiMerger'
+import fs from 'fs'
+
+test('merge()', async () => {
+  const merger = new OpenApiMerger('./tests/tools/merger/fixtures/spec/')
+  merger.merge('./tests/tools/merger/opensearch-openapi.yaml')
+  expect(fs.readFileSync('./tests/tools/merger/fixtures/expected.yaml', 'utf8'))
+    .toEqual(fs.readFileSync('./tests/tools/merger/opensearch-openapi.yaml', 'utf8'))
+  fs.unlinkSync('./tests/tools/merger/opensearch-openapi.yaml')
+})

tools/README.md

@@ -8,7 +8,7 @@ This folder contains tools for the repo:
 ## Setup
 
 1. Install [Node.js](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
-2. Run `npm install` in the `tools` folder
+2. Run `npm install`.
 
 ## Merger
 
@@ -19,14 +19,14 @@ It requires a path to the root folder of the multi-file spec (`--source`) and a
 Example:
 
 ```bash
-mkdir -p ../build
-npm run merge -- --source ../spec --output ../build/opensearch-openapi.yaml
+mkdir -p ./build
+npm run merge -- --source ./spec --output ./build/opensearch-openapi.yaml
 ```
 
 As a shortcut, if those parameters are not provided, the tool will use the default values:
 
 - `../spec` as the root path (i.e. the repo's [spec folder](../spec))
-- `../build/opensearch-openapi.yaml` as the output path
+- `./build/opensearch-openapi.yaml` as the output path
 
 ```bash
 npm run merge
@@ -41,7 +41,7 @@ The linter tool validates the OpenSearch multi-file spec, and will print out all
 It requires a path to the root folder of the multi-file spec (`--source`).
 
 ```bash
-npm run lint:spec -- --source ../spec
+npm run lint:spec -- --source ./spec
 ```
 
 Run `npm run lint:spec -- --help` for all options.

tools/merger/merge.ts

@@ -5,7 +5,7 @@ import { resolve } from 'path'
 const command = new Command()
   .description('Merges the multi-file OpenSearch spec into a single file for programmatic use.')
   .addOption(new Option('-s, --source <path>', 'path to the root folder of the multi-file spec').default(resolve(__dirname, '../../spec')))
-  .addOption(new Option('-o, --output <path>', 'output file name').default(resolve(__dirname, '../../build/opensearch-openapi.yaml')))
+  .addOption(new Option('-o, --output <path>', 'output file name').default(resolve(__dirname, '.././build/opensearch-openapi.yaml')))
   .allowExcessArguments(false)
   .parse()