chore: first commit

Author: gutyerrez

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+
+config
+bin

.npmignore

@@ -0,0 +1,34 @@
+.idea/
+.circleci
+.github
+.gitignore
+.prettierrc
+.travis.yml
+Makefile
+node_modules/
+.DS_Store
+CONTRIBUTE.md
+
+# source
+**/*.ts
+*.ts
+/test
+
+# definitions
+!**/*.d.ts
+!*.d.ts
+
+# configuration
+renovate.json
+gulpfile.js
+tsconfig.json
+tools
+/test/jest-config.json
+/.vscode
+.commitlintrc.json
+.eslintrc.js
+.eslintignore
+.release-it.json
+
+# sample
+/sample

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org/

README.md

@@ -0,0 +1,57 @@
+# Router Comparsion - Compare your server response data
+
+Comparing response data from servers when is migrating services.
+
+## Installation:
+
+```
+$ npm install -g @somosprte/route-comparison
+```
+
+## Flags
+
+`--config` used to specify location of request file(s) to be used in execution of requests
+
+## Configuration
+
+Example `config.yaml`:
+
+```yaml
+servers:
+  original: https://localhost:3333/v1
+  compare: https://localhost:3333/v2
+
+requests:
+  /healthcheck:
+    url: /healthcheck
+    method: GET
+
+  /users:
+    urls:
+      - /users/new
+      - /users/create
+    method: POST
+    headers:
+      Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxfQ.0Y4AEK4_wc8-qtz7ik1VMWc9bOStRWOCH_MNEm38dq0
+    data: |
+      {
+        "email: "viniciusgutierrez@prte.com.br",
+        "password": "12345678"
+      }
+    ignore: |
+      {
+        "data.attributes.avatar"
+      }
+```
+
+## Usage
+
+For multiple files:
+```
+$ route-comparison --config=requests
+```
+
+For specific file:
+```
+$ route-comparison --config=requests/request.yaml
+```

catalog-info.yaml

@@ -0,0 +1,11 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: lm-router-compairson
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+    github.com/project-slug: somosprte/lm-router-compairson
+spec:
+  type: other
+  lifecycle: unknown
+  owner: prte

docs/index.md

@@ -0,0 +1 @@
+### Hello World!

mkdocs.yaml

@@ -0,0 +1,7 @@
+site_name: 'Route Comparison'
+
+nav:
+  - Home: index.md
+
+plugins:
+  - techdocs-core

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@somosprte/route-comparison",
+  "version": "0.0.3-ALPHA",
+  "license": "MIT",
+  "publisher": "somosprte",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/somosprte/prte-route-comparison.git"
+  },
+  "author": {
+    "name": "Vinícius Gutierrez da Silva Rocha",
+    "email": "srgutyerrez@gmail.com"
+  },
+  "engines": {
+    "node": "18.x.x"
+  },
+  "bin": {
+    "route-comparison": "bin/index.js"
+  },
+  "scripts": {
+    "build": "rm -rf bin;tsc"
+  },
+  "dependencies": {
+    "axios": "^1.2.0",
+    "json-diff": "^1.0.0",
+    "yaml": "^2.1.3"
+  },
+  "devDependencies": {
+    "@types/json-diff": "^0.9.1",
+    "@types/node": "^18.11.7",
+    "@types/yaml": "^1.9.7",
+    "typescript": "^4.8.4"
+  }
+}

src/index.ts

@@ -0,0 +1,66 @@
+#! /usr/bin/env node
+
+import { existsSync, readFileSync } from 'fs'
+
+import { readdirSync, statSync } from 'fs'
+import { parse } from 'yaml'
+
+import { Validator } from './utils/validator'
+import { Request } from './schema/request'
+
+const startComparison = async () => {
+  let config = process.argv.map((flag) => {
+    return flag.replace(/(--?|-?)+[A-Za-z]+=/, '')
+  })[2]
+
+  if (!config) {
+    throw new Error('please provide a config file or directory')
+  }
+
+  if (!existsSync(config)) {
+    throw new Error(`cannot find config file or directory`)
+  }
+
+  const configDatas: { fileName: string; request: Request }[] = []
+
+  if (statSync(config).isDirectory()) {
+    const files = readdirSync(config)
+
+    for await (const file of files) {
+      configDatas.push({
+        fileName: file.split('.')[0],
+        request: parse(String(readFileSync(config.startsWith('/') ? `${config}/${file}` : `./${config}/${file}`))) as Request
+      })
+    }
+  } else {
+    configDatas.push({
+      fileName: config.split('/')[config.split('/').length - 1].split('.')[0],
+      request: parse(String(readFileSync(config.startsWith('/') ? config : `./${config}`))) as Request
+    })
+  }
+
+  for await (const { fileName, request } of configDatas) {
+    const original = request['servers'].original
+    const compare = request['servers'].compare
+  
+    Object.values(request.requests).forEach(async (request) => {
+      const validator = new Validator(
+        [
+          original + (request.url ?? request.urls![0]),
+          compare + (request.url ?? request.urls![1])
+        ],
+        request.method,
+        request.headers,
+        request.data,
+        fileName,
+        JSON.parse(request.ignore ?? '[]')
+      )
+  
+      const responses = await validator.execute()
+  
+      validator.compare(responses)
+    })
+  }
+}
+
+startComparison()

src/schema/request.ts

@@ -0,0 +1,16 @@
+export type Request = {
+  servers: {
+    original: string;
+    compare: string;
+  }
+  requests: {
+    [ key: string ]: {
+      url?: string
+      urls?: string[]
+      method: 'GET' | 'POST' | 'PUT' | 'DELETE'
+      headers?: object
+      data?: object
+      ignore?: string
+    }
+  }
+}