ts ddd sample

Author: nelsonkopliku

.env

@@ -0,0 +1,8 @@
+# DATABASE
+DB_CONNECTION=mysql
+DB_HOST=cluster_management_db
+# DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USERNAME=admin
+DB_PASSWORD=admin
+DB_DATABASE=cluster_node_management

.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

@@ -0,0 +1,36 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+docker-compose.override.yaml

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "printWidth": 120,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true,
+  "endOfLine": "lf",
+  "arrowParens": "avoid"
+}

Makefile

@@ -0,0 +1,32 @@
+.DEFAULT_GOAL := help
+.SILENT:
+
+## Colors
+COLOR_RESET   = \033[0m
+COLOR_INFO    = \033[32m
+COLOR_COMMENT = \033[33m
+
+## Help
+help:
+	printf "${COLOR_COMMENT}Usage:${COLOR_RESET}\n"
+	printf " make [target]\n\n"
+	printf "${COLOR_COMMENT}Available targets:${COLOR_RESET}\n"
+	awk '/^[a-zA-Z\-\_0-9\.@]+:/ { \
+		helpMessage = match(lastLine, /^## (.*)/); \
+		if (helpMessage) { \
+			helpCommand = substr($$1, 0, index($$1, ":")); \
+			helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
+			printf " ${COLOR_INFO}%-16s${COLOR_RESET} %s\n", helpCommand, helpMessage; \
+		} \
+	} \
+	{ lastLine = $$0 }' $(MAKEFILE_LIST)
+
+## starts platform
+start:
+	@echo Running \${COLOR_INFO}\`docker-compose up -d\`\${COLOR_RESET} ...
+	docker-compose up -d
+
+## destroys containers and recreates platform
+recreate:
+	@echo Running \${COLOR_INFO}\`docker-compose down -v --remove-orphans\`\${COLOR_RESET} ...
+	docker-compose down -v --remove-orphans && make start

README.md

@@ -0,0 +1,114 @@
+# Cluster Node API
+
+## Getting started
+
+### System requirements
+
+-   git
+-   docker
+-   docker-compose
+
+## Startup
+
+A `Makefile` provides a couple of commands
+
+```shell
+$ make
+Usage:
+ make [target]
+
+Available targets:
+ help:            Help
+ start:           starts platform
+ recreate:        destroys containers and recreates platform
+```
+To startup the project just run `make start`.
+Wait a bit for the containers to start and then browse [http://localhost:3000/api](http://localhost:3000/api) and you should see a Swagger UI
+
+![Screenshot](./docs/assets/img.png)
+
+## Authentication
+```text
+username: john.doe
+password: password
+```
+```shell
+curl --request POST 'http://localhost:3000/api/v1/auth/login' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "username": "john.doe",
+    "password": "password"
+}'
+```
+
+it will give an access token that should be used to access other APIs
+
+```shell
+{
+    "access_token": "<THE GENERATED TOKEN>"
+}
+```
+
+```shell
+curl --request GET 'http://localhost:3000/api/v1/<some endpoint>' \
+--header 'Authorization: Bearer <THE GENERATED TOKEN>'
+```
+
+<details>
+  <summary>See Assignment document!</summary>
+
+# Interview Assignment - Cluster Node API
+
+Hello, dear candidate! Thanks for taking the time to try this out.
+
+The goal of this assignment is to assert (to some degree) your skills as a software engineer. You should focus on showcasing your skill at coding and problem solving. The solution is intentionally open-ended, to give you space for personal interpretation, but for all intents and purposes you can pretend that you're building a production-ready application!
+
+You can develop the assignment in any common language you can demonstrate being comfortable coding with.
+
+You're **allowed and encouraged** to use third party libraries and tools, as long as they are free and open source. An effective developer knows what to build and what to reuse, but also how his/her tools work. Be prepared to answer some questions about these, like why you chose them and what other alternatives you considered.
+
+As this is a code review process, please minimize generated code, as this might make our jobs as reviewers more difficult.
+
+_Note: While we love open source at SUSE, please do not create a public repo with your assignment in! This test is only shared with people interviewing, and for obvious reasons we'd like it to remain this way._
+
+## Instructions
+
+1. Clone this repository.
+2. Create a pull request targeting the master branch of this repository.
+   This PR should contain setup instructions for your application and a breakdown of the technologies & packages you chose to use, why you chose to use them, and the design decisions you made.
+3. Reply to the email thread you're having with our HR department telling them we can start reviewing your code.
+
+## Requirements
+
+Create a simple API to manage nodes of computing clusters.
+We'll refer to this as "The API" throughout the rest of this document.
+
+There are two possible types of end users for this API: an unauthenticated one, and an authenticated one. We'll refer to these as "anonymous user" and "privileged user" respectively. The privileged user can implicitly also do everything the anonymous user can.
+
+- As an anonymous user, I shall be able to access The API remotely.
+- As an anonymous user, I shall be able to read a list of features The API offers.
+- As an anonymous user, I shall be informed when trying to use a feature that is only available to privileged users.
+- As a privileged user, I shall be able to search for nodes, either by node name or by cluster name.
+- As a privileged user, I shall be able to create/read/update/delete nodes.
+- As a privileged user, I shall be able to issue power-on/shutdown/reboot commands to a single node.
+
+### Constraints and details
+
+- The achitectural patterns, protocols and schemas used to implement The API are left as free design decisions.
+- The only required entity handled by The API is a cluster _node_. Clusters are not required to be handled as a dedicated entity.
+- The state represented by The API obviously doesn't have to be an actual cluster: the _single source of truth_ is expected to be simulated by any mean necessary (filesystem, database, object storage, etc); the only requirement is that such state must be persistent, i.e. restarting The API doesn't clear the data.
+- The API itself doesn't _need_ to be "containerized" but, as a developer, I should be able to perform changes to the source code of The API and observe the results, by building/running it, on a Linux system which only provides an OCI container engine, without installing any new packages.
+- Additional features you might want to autonomously define and implement are welcome!
+
+
+## What to expect from the review
+
+The review of your solution will happen in two phases:
+1. First, you'll have a chance to interact with the interviewer[s] in a traditional asynchronous code review, like you would do on GitHub every day.
+2. After the async peer review is done, we'll schedule a live chat with team, where further in-depth questions might be asked, to give you the chance to meet your potential future colleagues!
+
+## Good luck
+
+Code something awesome!
+
+</details>

docker-compose.override.yaml.dist

@@ -0,0 +1,6 @@
+version: '3.8'
+
+services:
+    
+    cluster_management_db:
+        platform: linux/x86_64

docker-compose.yaml

@@ -0,0 +1,31 @@
+version: '3.8'
+
+services:
+    cluster_management_api:
+        build:
+            context: .
+            dockerfile: ./docker/backend/Dockerfile
+        ports:
+            - 3000:3000
+        volumes:
+            - ./:/app
+        depends_on:
+            - cluster_management_db
+        command: sh -c "yarn && yarn start:dev"
+    
+    cluster_management_db:
+        image: mysql:8.0.25
+        ports:
+            - 3306:3306
+        environment:
+            - MYSQL_ROOT_PASSWORD=root
+            - MYSQL_DATABASE=cluster_node_management
+            - MYSQL_USER=admin
+            - MYSQL_PASSWORD=admin
+        volumes:
+            - cluster_management_db_volume:/var/lib/mysql
+            - ./docker/mysql/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d:rw
+            - ./docker/mysql/etc/conf.d/my.cnf:/etc/mysql/conf.d/custom.cnf
+    
+volumes:
+    cluster_management_db_volume:

docker/backend/Dockerfile

@@ -0,0 +1,20 @@
+FROM node:14.17-alpine
+
+RUN mkdir -p /app && \
+     chown -R node:node /app && \
+     npm install -g ts-node @nestjs/cli
+
+USER node
+
+WORKDIR /app
+
+COPY --chown=node:node package.json /app
+COPY --chown=node:node yarn.lock /app
+COPY --chown=node:node tsconfig.json /app
+
+COPY --chown=node:node ./dist /app/dist
+# Should we copy the whole project in the image?
+
+RUN yarn install && yarn build
+
+CMD ["node", "./dist/main.js"]

docker/mysql/docker-entrypoint-initdb.d/create_schema.sql

@@ -0,0 +1,28 @@
+CREATE TABLE IF NOT EXISTS nodes (
+    id VARCHAR (36), -- maybe should be something like BINARY or similar
+    cluster VARCHAR(255) NOT NULL,
+    `name` VARCHAR(255) NOT NULL,
+    is_powered_on BOOLEAN DEFAULT 0,
+    UNIQUE (cluster, `name`),
+    FULLTEXT idx_node_fulltext(`name`),
+    PRIMARY KEY (id)
+) ENGINE=InnoDB;
+
+INSERT INTO nodes (
+    id,
+    cluster,
+    `name`,
+    is_powered_on
+) VALUES
+('dfa7b991-4e02-4fd5-960b-c63899757b83', 'b27f20e0-08d2-4401-8d5a-9f1dd1f1414f', 'node-01', 0),
+('e53942ee-4bbe-4027-b2fc-afd18c26c20f', 'b27f20e0-08d2-4401-8d5a-9f1dd1f1414f', 'node-02', 1),
+('161c3c62-a3ca-480f-8035-40e340e4ed4c', 'b27f20e0-08d2-4401-8d5a-9f1dd1f1414f', 'node-03', 1),
+('a32532b3-f8f6-4563-8562-0ae313a24563', 'b27f20e0-08d2-4401-8d5a-9f1dd1f1414f', 'node-04', 0),
+('16e2ef00-daa4-4346-b672-4c7b0e86f2f4', 'b27f20e0-08d2-4401-8d5a-9f1dd1f1414f', 'node-05', 1),
+('4d8af223-f3e0-4cfc-9936-63226bad0941', 'b27f20e0-08d2-4401-8d5a-9f1dd1f1414f', 'node-06', 0),
+('eba84c8b-d530-44bf-b341-067b76a17bdc', 'e9ad75c2-c8d8-40b8-891d-4a56fd8fa6eb', 'node-01', 1),
+('0dd7c8a2-b78e-4375-a155-42544b6f6acd', 'e9ad75c2-c8d8-40b8-891d-4a56fd8fa6eb', 'node-02', 1),
+('417db5fc-397a-47ad-869f-4ab65f43a807', 'e9ad75c2-c8d8-40b8-891d-4a56fd8fa6eb', 'node-03', 0),
+('30f7e626-e771-4a93-8552-34addd769b42', 'e9ad75c2-c8d8-40b8-891d-4a56fd8fa6eb', 'node-04', 0),
+('887229ac-e483-4273-961e-fb523fe68ac3', 'e9ad75c2-c8d8-40b8-891d-4a56fd8fa6eb', 'node-05', 1),
+('bb9e1bd9-a558-4c73-af26-4f50df473ffe', 'e9ad75c2-c8d8-40b8-891d-4a56fd8fa6eb', 'node-06', 1);

docker/mysql/etc/conf.d/my.cnf

@@ -0,0 +1,4 @@
+[mysqld]
+character-set-server = utf8
+collation-server = utf8_unicode_ci
+skip-character-set-client-handshake

docs/assets/img.png

@@ -0,0 +1,4 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}