add skeleton for frontend backed api testing

AgileIndustrialComplex · kelsos · commit 95047484cbbc · 2024-01-19T14:35:53.000+01:00
adds new entrypoint for mocked rotki server which returns OK response
for any valid request
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-COMMON_LINT_PATHS = rotkehlchen/ package.py
+COMMON_LINT_PATHS = rotkehlchen/ rotkehlchen_mock/ package.py
 TOOLS_LINT_PATH = tools/
 ALL_LINT_PATHS = $(COMMON_LINT_PATHS) $(TOOLS_LINT_PATH)
 ISORT_PARAMS = --ignore-whitespace --skip-glob '*/node_modules/*' $(ALL_LINT_PATHS)
diff --git a/frontend/app/.env.contract b/frontend/app/.env.contract
@@ -0,0 +1,4 @@
+CODE_COVERAGE=true
+VITE_BACKEND_URL=http://127.0.0.1:22221
+VITE_TEST=true
+VITE_SILENT_TRANSLATION_WARN=true
diff --git a/frontend/app/.gitignore b/frontend/app/.gitignore
@@ -38,5 +38,6 @@ rotki_config.json
 package-lock.json
 components.d.ts
 .e2e
+.contract
 
 src/data/external-links.js
diff --git a/frontend/app/package.json b/frontend/app/package.json
@@ -25,6 +25,7 @@
     "postuninstall": "electron-builder install-app-deps",
     "serve": "node scripts/serve.js --web",
     "serve:backend": "node scripts/start-backend.js",
+    "test:contract": "node scripts/contract.js",
     "test:integration": "node scripts/e2e.js",
     "test:integration-ci": "node scripts/e2e.js --ci",
     "test:unit": "cross-env TZ=UTC VITE_TEST=true vitest --dir tests/unit --coverage",
diff --git a/frontend/app/scripts/contract.js b/frontend/app/scripts/contract.js
@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+const path = require('node:path');
+const { startAndTest } = require('start-server-and-test');
+const { ArgumentParser } = require('argparse');
+
+function info(msg) {
+  console.info(`\n\u001B[32m${msg}\u001B[0m\n`);
+};
+
+const parser = new ArgumentParser({
+  description: 'contract tests, this checks compliance between frontend and backend',
+});
+parser.add_argument('--spec', { help: 'specific spec to run ' });
+
+const { spec } = parser.parse_args();
+
+require('dotenv').config({
+  path: path.join(process.cwd(), '.env.contract'),
+});
+
+const backendUrl = process.env.VITE_BACKEND_URL;
+
+const services = [
+  {
+    start: 'node scripts/start-mocked-backend.js',
+    url: `${backendUrl}/api/1/ping`,
+  },
+];
+
+const testCmd = 'cross-env TZ=UTC VITE_TEST=true vitest run --dir tests/contract --coverage';
+
+let test = testCmd;
+if (spec)
+  test += ` --spec **/${spec}`;
+
+async function run() {
+  startAndTest({
+    services,
+    test,
+    namedArguments: { expect: 200 },
+  })
+    .then(() => {
+      info('Execution completed successfully');
+      process.exit(0);
+    })
+    .catch(() => {
+      console.error('Command execution failed');
+      process.exit(1);
+    });
+}
+
+// re-evaluate after moving to mjs or ts
+// eslint-disable-next-line unicorn/prefer-top-level-await
+run();
diff --git a/frontend/app/scripts/start-mocked-backend.js b/frontend/app/scripts/start-mocked-backend.js
@@ -0,0 +1,68 @@
+const { spawn } = require('node:child_process');
+const fs = require('node:fs');
+const path = require('node:path');
+
+if (!(process.env.CI || process.env.VIRTUAL_ENV)) {
+  process.stdout.write(`\u001B[31mError\u001B[0m: Not CI or VIRTUAL_ENV\n\n`);
+  process.exit(1);
+}
+
+const testDir = path.join(process.cwd(), '.contract');
+const dataDir = path.join(testDir, 'data');
+
+process.stdout.write(`Using ${dataDir} to start tests\n`);
+
+function cleanupData() {
+  const contents = fs.readdirSync(dataDir);
+  for (const name of contents) {
+    if (['images', 'global'].includes(name))
+      continue;
+
+    const currentPath = path.join(dataDir, name);
+    if (fs.statSync(currentPath).isDirectory())
+      fs.rmSync(currentPath, { recursive: true });
+  }
+};
+
+if (!fs.existsSync(dataDir))
+  fs.mkdirSync(dataDir, { recursive: true });
+else
+  cleanupData();
+
+const logDir = path.join(testDir, 'logs');
+
+process.stdout.write(`Using ${logDir} to output backend logs\n`);
+
+if (!fs.existsSync(logDir))
+  fs.mkdirSync(logDir, { recursive: true });
+
+const args = [
+  '-m',
+  'rotkehlchen_mock',
+  '--rest-api-port',
+  '22221',
+  '--websockets-api-port',
+  '22222',
+  '--api-cors',
+  'http://localhost:*',
+  '--data-dir',
+  dataDir,
+  '--logfile',
+  `${path.join(logDir, 'contract.log')}`,
+];
+
+let backend;
+
+process.on('SIGTERM', () => {
+  if (backend)
+    backend.kill();
+
+  cleanupData();
+  process.stdout.write('Cleanup: complete\n');
+  process.exit(0);
+});
+
+backend = spawn('python', args, {
+  stdio: [process.stdin, process.stdout, process.stderr],
+  cwd: path.join('..', '..'),
+});
diff --git a/frontend/app/tests/contract/.eslintrc.js b/frontend/app/tests/contract/.eslintrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    'max-lines': 'off',
+  },
+};
diff --git a/frontend/app/tests/contract/specs/contract.spec.ts b/frontend/app/tests/contract/specs/contract.spec.ts
@@ -0,0 +1,10 @@
+/*
+    grep "const use.*Api" ./app/src/auto-imports.d.ts | cut -d ' ' -f4 | tr -d ':'
+*/
+
+describe('test compliance with User Api', () => {
+  const api = useUsersApi();
+  it('gets user profiles', async () => {
+    await api.getUserProfiles();
+  });
+});
diff --git a/frontend/app/tests/contract/tsconfig.json b/frontend/app/tests/contract/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "types": ["vuetify", "vitest/globals"]
+  },
+  "include": ["**/*.ts", "../../src/auto-imports.d.ts"],
+  "exclude": ["node_modules/**", "**/.*"],
+  "compileOnSave": false
+}
diff --git a/frontend/package.json b/frontend/package.json
@@ -18,14 +18,15 @@
     "lint": "eslint --cache . && pnpm run -r lint:style",
     "lint:fix": "eslint --cache . --fix",
     "check": "pnpm run lint && pnpm run build && pnpm run test:unit",
-    "check:all": "pnpm run lint && pnpm run build && pnpm run --filter @rotki/common test:unit --w app && pnpm run --filter rotki test:integration-ci",
+    "check:all": "pnpm run lint && pnpm run build && pnpm run --filter @rotki/common test:unit --w app && pnpm run --filter rotki test:integration-ci && pnpm run --filter rotki test:contract",
     "check:return-type": "eslint --no-eslintrc --env \"node\" --parser \"@typescript-eslint/parser\" --plugin \"@typescript-eslint\",\"import\" --rule \"{@typescript-eslint/explicit-function-return-type:warn}\" '{app,common}/src/**/*.ts'",
     "clean:modules": "rimraf node_modules app/node_modules common/node_modules dev-proxy/node_modules app/dist app/electron-build app/.e2e common/lib",
     "dev": "node scripts/start-dev.js",
     "preview": "pnpm run --filter rotki preview",
-    "test": "pnpm run test:unit && pnpm run test:integration-ci",
+    "test": "pnpm run test:unit && pnpm run test:integration-ci && pnpm run test:contract",
     "test:unit": "pnpm run --filter rotki test:unit:run",
     "test:unit:watch": "pnpm run --filter rotki test:unit",
+    "test:contract": "pnpm run --filter rotki test:contract",
     "test:integration": " pnpm run --filter rotki test:integration",
     "test:integration-ci": " pnpm run --filter rotki test:integration-ci",
     "dev:web": "node scripts/start-dev.js --web",
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,6 +30,7 @@ include = ["rotkehlchen*"]
 
 [project.scripts]
 rotkehlchen = "rotkehlchen.__main__:main"
+rotkehlchen_mock = "rotkehlchen_mock.__main__:main"
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}
diff --git a/rotkehlchen_mock/__init__.py b/rotkehlchen_mock/__init__.py
diff --git a/rotkehlchen_mock/__main__.py b/rotkehlchen_mock/__main__.py
@@ -0,0 +1,74 @@
+from gevent import monkey
+
+monkey.patch_all()  # isort:skip
+
+import logging
+from http import HTTPStatus
+from typing import Any
+
+import gevent
+from flask import Response
+
+from rotkehlchen.api.rest import RestAPI, api_response
+from rotkehlchen.api.server import APIServer
+from rotkehlchen.args import app_args
+from rotkehlchen.logging import TRACE, RotkehlchenLogsAdapter, add_logging_level, configure_logging
+from rotkehlchen.rotkehlchen import Rotkehlchen
+from rotkehlchen.server import RotkehlchenServer
+
+logger = logging.getLogger(__name__)
+log = RotkehlchenLogsAdapter(logger)
+add_logging_level('TRACE', TRACE)
+
+
+def get_well_formed_response(*_: Any) -> Response:
+    """
+    Gets a valid OK api response.
+
+    Arguments passed to this function are ignored.
+    """
+    return api_response(result={'result': {}}, status_code=HTTPStatus.OK)
+
+
+class RotkehlchenServerMock(RotkehlchenServer):
+    def __init__(self) -> None:  # pylint: disable=super-init-not-called
+        # mock entry point inherits all the cmd args of normal entry point
+        arg_parser = app_args(prog='rotkehlchen_mock', description='mocked rotki server')
+
+        # you can add additional cmd args
+        args = arg_parser.parse_args()
+
+        configure_logging(args)
+
+        rotkehlchen = Rotkehlchen(args)
+        rest_api = RestAPI(rotkehlchen)
+        if ',' in args.api_cors:
+            domain_list = [str(domain) for domain in args.api_cors.split(',')]
+        else:
+            domain_list = [str(args.api_cors)]
+
+        self.args = args
+        self.rotkehlchen = rotkehlchen
+        self.stop_event = gevent.event.Event()
+
+        self.api_server = APIServer(
+            rest_api=rest_api,
+            ws_notifier=self.rotkehlchen.rotki_notifier,
+            cors_domain_list=domain_list,
+        )
+
+        # patch all methods except special ones and those managing state of the app
+        functions_to_patch = (
+            member_name
+            for member_name in dir(rest_api)
+            if callable(getattr(rest_api, member_name)) and
+            not member_name.startswith('__') and
+            member_name != 'stop'
+        )
+
+        for function_name in functions_to_patch:
+            setattr(rest_api, function_name, get_well_formed_response)
+
+
+if __name__ == '__main__':
+    RotkehlchenServerMock().main()

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-COMMON_LINT_PATHS = rotkehlchen/ package.py`
	`1`	`+COMMON_LINT_PATHS = rotkehlchen/ rotkehlchen_mock/ package.py`
`2`	`2`	`TOOLS_LINT_PATH = tools/`
`3`	`3`	`ALL_LINT_PATHS = $(COMMON_LINT_PATHS) $(TOOLS_LINT_PATH)`
`4`	`4`	`ISORT_PARAMS = --ignore-whitespace --skip-glob '/node_modules/' $(ALL_LINT_PATHS)`