@nathapp/na-cli 1.0.1-rc.6 → 1.0.2

package/dist/templates/mxw-base-api-express/.gitlab-ci.yml

@@ -1,174 +0,0 @@
-# Project must implement Makefile for commands (test, version-prerelease, version-patch, name, version, image)
-# command:
-#   - test: run project test cases
-#   - version-prerelease: bump prerelease version
-#   - version-patch: bump release version
-#   - name: display project name
-#   - version: display project version
-#   - image: display project name and version (e.g. hello-world:1.0.0)
-#
-stages:
-  # run test cases
-  - test
-  # build container image and push to registry
-  - prepare
-  - build-init
-  - build
-  - build-commit
-  # mark release commit as verified
-  - release
-  - notify
-
-run-test:
-  stage: test
-  image: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/docker:18-ci
-  services:
-    - docker:18-dind
-  script:
-    - make test
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_COMMIT_TAG != null'
-      when: never
-    # Merge request
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-    # Commit to protected branch or commit branch is default branch (master)
-    - if: '$CI_COMMIT_REF_PROTECTED == "true" || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-    # Commit message contains `run-test` keyword
-    - if: '$CI_COMMIT_MESSAGE =~ /run-test/'
-    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
-    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-
-run-pre-prepare:
-  stage: prepare
-  image: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/node:10.20.0-alpine-ci-1
-  artifacts:
-    paths:
-      - package.json
-      - package-lock.json
-      - image-tag.txt
-      - postman-collection.json
-  script:
-    - make spec
-    - make version-prerelease
-    - make image | awk '{ printf("%s/%s/%s", ENVIRON["CONTAINER_REGISTRY_URL"], ENVIRON["CONTAINER_REGISTRY_NAMESPACE"], $0)}' > image-tag.txt
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
-      when: never
-    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
-    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-
-run-prepare:
-  stage: prepare
-  image: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/node:10.20.0-alpine-ci-1
-  artifacts:
-    paths:
-      - package.json
-      - package-lock.json
-      - image-tag.txt
-      - postman-collection.json
-  script:
-    - make spec
-    - make version-patch
-    - make image | awk '{ printf("%s/%s/%s", ENVIRON["CONTAINER_REGISTRY_URL"], ENVIRON["CONTAINER_REGISTRY_NAMESPACE"], $0)}' > image-tag.txt
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
-      when: never
-    # Commit into default branch (master)
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
-run-build-warmer:
-  stage: build-init
-  image: 
-    name: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/kaniko-warmer:debug
-    entrypoint: [""]
-  before_script:
-    - echo "$DOCKER_AUTH_CONFIG" > /kaniko/.docker/config.json
-  script:
-    - warmer `cat $CI_PROJECT_DIR/Dockerfile | grep FROM | awk -F" " '{ printf("--image=%s ", $2) }'`
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
-      when: never
-    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
-    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-    # Commit into default branch (master)
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
-run-build:
-  stage: build
-  image: 
-    name: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/kaniko-executor:debug
-    entrypoint: [""]
-  artifacts:
-    paths:
-      - image-digest.txt
-  before_script:
-    - echo "$DOCKER_AUTH_CONFIG" > /kaniko/.docker/config.json
-  script:
-    - echo "BUILDING... `cat $CI_PROJECT_DIR/image-tag.txt`"
-    - if [ -f $CI_PROJECT_DIR/dependency.txt ] && ! [ -z "`cat $CI_PROJECT_DIR/dependency.txt`" ]; then cat $CI_PROJECT_DIR/dependency.txt | awk '{$1=$1;print;exit}' > $CI_PROJECT_DIR/dep.txt; else echo > $CI_PROJECT_DIR/dep.txt; fi
-    - echo -n 'LABEL DEPENDENCY='; cat $CI_PROJECT_DIR/dep.txt
-    - executor --cache=true --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --digest-file $CI_PROJECT_DIR/image-digest.txt --destination "`cat $CI_PROJECT_DIR/image-tag.txt`" --label "dependency=`cat $CI_PROJECT_DIR/dep.txt`"
-    - echo "PUSHED `cat $CI_PROJECT_DIR/image-tag.txt` (`cat $CI_PROJECT_DIR/image-digest.txt`)"
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
-      when: never
-    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
-    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-    # Commit into default branch (master)
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
-run-build-commit:
-  stage: build-commit
-  image: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/node:10.20.0-alpine-ci-1
-  before_script:
-    - git config --global user.name "$GITLAB_USER_NAME"
-    - git config --global user.email "$GITLAB_USER_EMAIL"
-  script:
-    - git add -A
-    - git commit -m "$(make version)" -m "== release-by-bot ($CI_COMMIT_SHA) =="
-    - git tag -a "$(make version)" -m "$(cat image-tag.txt) ($(cat image-digest.txt))"
-    - git push "https://${GITLAB_USER_NAME}:${CI_GIT_TOKEN}@${CI_REPOSITORY_URL#*@}" "HEAD:${CI_COMMIT_BRANCH}"
-    - git push "https://${GITLAB_USER_NAME}:${CI_GIT_TOKEN}@${CI_REPOSITORY_URL#*@}" --tags
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
-      when: never
-    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
-    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-    # Commit into default branch (master)
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
-run-release:
-  stage: release
-  image: registry-intl.cn-hongkong.aliyuncs.com/d_mxw/node:10.20.0-alpine-ci-1
-  script:
-    - echo "Bumped version $(make version)"
-  rules:
-    # NOT commit message contains `run-without-release` keyword and NOT merge request
-    - if: '$CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event"'
-      when: never
-    # Tag was created
-    - if: '$CI_COMMIT_TAG != null'
-
-run-notify:
-  stage: notify
-  image: registry-intl.cn-hongkong.aliyuncs.com/gkci/node:10.20.0-alpine-ci-1
-  before_script:
-    - apk --no-cache add curl
-  script:
-    - 'curl -X POST -H "Content-Type: application/json" -d "{\"chat_id\": \"$TELEGRAM_CHAT_ID\", \"text\": \"CI: $CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME version:$(make version) has been released \"}" https://api.telegram.org/bot$TELEGRAM_BOT_TOKEN/sendMessage'
-  rules:
-    # NOT triggerred by bot and NOT commit message contains `run-without-release` keyword and NOT merge request and NOT tag was created
-    - if: '$CI_COMMIT_MESSAGE =~ /release-by-bot/ || $CI_COMMIT_MESSAGE =~ /run-without-release/ || $CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_TAG != null'
-      when: never
-    - if: '$TELEGRAM_BOT_TOKEN == null || $TELEGRAM_BOT_TOKEN == "" || $TELEGRAM_CHAT_ID == null || $TELEGRAM_CHAT_ID == ""'
-      when: never
-    # Commit message contains `run-prerelease` keyword and commit branch is not default branch (master)
-    - if: '$CI_COMMIT_MESSAGE =~ /run-prerelease/ && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-    # Commit into default branch (master)
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'

package/dist/templates/mxw-base-api-express/.nvmrc

@@ -1 +0,0 @@
-v14.18.2

package/dist/templates/mxw-base-api-express/Dockerfile

@@ -1,14 +0,0 @@
-FROM node:14.15.5-buster as builder
-WORKDIR /backend/
-ADD ./package.json /backend/
-ADD ./package-lock.json /backend/
-ADD ./tsconfig.json /backend/
-ADD ./src /backend/src
-RUN npm ci --production && npm cache clean --force
-RUN npm run build
-
-FROM node:14.15.5-alpine3.13
-WORKDIR /backend/
-COPY --chown=node:node --from=builder /backend /backend/
-USER node
-CMD [ "node", "dist/server.js" ]

package/dist/templates/mxw-base-api-express/Makefile

@@ -1,84 +0,0 @@
-MAKEFILE := $(abspath $(lastword $(MAKEFILE_LIST)))
-ROOT_PATH := $(shell pwd)
-SERVICE_NAME := <%= projectName %>
-
-.PHONY: version name image
-
-version-major: version-sync
-	@npm -s version major --no-git-tag-version
-
-version-minor: version-sync
-	@npm -s version minor --no-git-tag-version
-
-version-patch: version-sync
-	@npm -s version patch --no-git-tag-version
-
-version-prerelease: version-sync
-	@npm -s version prerelease --preid=rc --no-git-tag-version
-
-version-latest:
-	@(git tag --sort=-creatordate || echo) | awk 'NR==1 { \
-		split($$0, n, "-"); \
-		if (n[1] != "") { \
-			split(n[1], v, "."); \
-			if (v[1] ~ /^[0-9]+$$/ && v[2] ~ /^[0-9]+$$/ && v[3] ~ /^[0-9]+$$/) { \
-				print $$0; \
-				exit 0; \
-			} \
-		} \
-		print "1.0.0-rc.0"; \
-	 } \
-	 END { \
-		 if (NR == 0) { \
-			 print "1.0.0-rc.0"; \
-		 } \
-	 }'
-
-version-sync:
-	@git checkout $(CI_COMMIT_BRANCH)
-	@git pull --tags 2&>/dev/null || true
-	@git tag --sort=-creatordate | head -10
-	@cat package.json | jq -r --arg PKG_VERSION `make --no-print-directory -f$(MAKEFILE) version-latest` '.version=$$PKG_VERSION' > package.json;
-	@echo -n "Current Git tag: "; cat package.json | jq -r '.version'
-
-version:
-	@echo $(shell node -p "require('$(ROOT_PATH)/package.json').version")
-
-name:
-	@echo $(SERVICE_NAME)
-
-image:
-	@echo $(SERVICE_NAME):$(shell node -p "require('$(ROOT_PATH)/package.json').version")
-
-test:
-	@npm i
-	@npm run -s test
-
-spec:
-	@set -e -o pipefail; \
-		if [ -f "$(ROOT_PATH)/spec.yaml" ]; then \
-			make --no-print-directory -f$(MAKEFILE) spec-file > $(ROOT_PATH)/all-spec.yaml; \
-			openapi2postmanv2 -s $(ROOT_PATH)/all-spec.yaml -o postman-collection.json | \
-				awk ' \
-					BEGIN{ result = 0; error = "" } \
-					{ \
-						if (0 < index($$0, "Conversion successful, collection written to file")) { \
-							result = 1; \
-						} \
-						error = error $$0; \
-					} \
-					END{ \
-						if (result != 1) { \
-							print error; \
-							exit(-1); \
-						} \
-					}'; \
-			rm -f $(ROOT_PATH)/all-spec.yaml; \
-		fi;
-
-spec-file:
-	@cat $(ROOT_PATH)/spec.yaml;
-	@for file in `find $(ROOT_PATH)/src -iname "*-spec.yaml"`; do \
-		echo ""; \
-		cat $$file; \
-	done;

package/dist/templates/mxw-base-api-express/README.md

@@ -1,71 +0,0 @@
-# <%= projectName %>
-
-### Getting Started
-
-The <%= projectName %> API endpoints.
-
-### How to setup environment?
-
-1. Clone this repository.
-
-2. Change directory to the repository.
-
-3. Install package dependencies.
-   ```
-   npm install
-   ```
-4. Allow `direnv` to populate environment variables from the `.envrc` file. The `direnv` command is required to be installed.
-   ```
-   direnv allow .
-   ```
-
-### How to run unit-test?
-
-1. Write test cases in a `*.test.ts` file under the same folder with the actual module file. For example, module file `src/app-service.ts`, unit-test file `src/app-service.test.ts`.
-
-2. Run unit-test command.
-
-   - To run single module unit-test.
-
-     ```
-     npm run test-this src/app-service.test.ts
-     ```
-
-   - To run all unit-test.
-     ```
-     npm run test
-     ```
-
-### How to debug?
-
-Please use unit-test method for debugging.
-
-1. Set breakpoint on the source code by pressing `F9` key.
-
-2. Run unit-test command with debugging.
-
-   ```
-   npm run debug-this src/app-service.test.ts
-   ```
-
-3. Start debugging by pressing `F5` key.
-
-### How to release version?
-
-Git pipeline will perform unit-test, build container image and push to the container registry.
-
-- Bump a `prerelease` version (E.g. `1.0.0-rc.0`).
-
-  - Write commit message that contain `run-prerelease` keyword to `feature` branch.
-
-- Bump a `release` version (E.g. `1.0.0`).
-
-  - Merge into `default` branch (main/master) with any commit message.
-
-> Note: **Code review** process should be perform before merge into `default` branch or release version.
-
-### Merge into default branch without trigger pipeline
-
-If you want to merge into `default` branch without triggering the pipeline, write commit message that contain `run-without-release`.
-
-chatbot: 0

package/dist/templates/mxw-base-api-express/package.json

@@ -1,55 +0,0 @@
-{
-  "name": "<%= projectName %>",
-  "version": "1.0.0-rc.0",
-  "description": "API Description",
-  "repository": {},
-  "devDependencies": {
-    "@types/chai": "^4.3.0",
-    "@types/sinon": "^10.0.6",
-    "chai": "^4.3.4",
-    "dotenv": "^8.2.0",
-    "mocha": "^9.1.3",
-    "sinon": "^12.0.1",
-    "ts-node": "^10.4.0",
-    "tsconfig-paths": "^3.12.0"
-  },
-  "dependencies": {
-    "@types/body-parser": "^1.19.2",
-    "@types/cors": "^2.8.12",
-    "@types/express": "^4.17.13",
-    "@types/jsonwebtoken": "^9.0.0",
-    "@types/multer": "^1.4.7",
-    "@types/node": "^14.18.2",
-    "@types/response-time": "^2.3.5",
-    "body-parser": "^1.19.1",
-    "cors": "^2.8.5",
-    "express": "^4.17.2",
-    "form-data": "^3.0.1",
-    "jsonwebtoken": "^9.0.0",
-    "multer": "1.4.4-lts.1",
-    "mxw-libs-api-token": "^1.0.13",
-    "mxw-libs-clogger": "^1.0.0",
-    "mxw-libs-database": "^1.0.19",
-    "mxw-libs-email-notify": "^1.0.6",
-    "mxw-libs-errors": "^1.0.5",
-    "mxw-libs-push-notify": "^1.0.5",
-    "mxw-libs-utils": "^1.0.35",
-    "process": "^0.11.10",
-    "response-time": "^2.3.2",
-    "streamifier": "^0.1.1",
-    "typescript": "^4.5.4"
-  },
-  "scripts": {
-    "build": "npm run build-ts",
-    "build-ts": "tsc",
-    "dev": "npm run build && NODE_ENV=local node dist/server.js",
-    "start": "node dist/server.js",
-    "test": "mocha --recursive --timeout 30000 -r tsconfig-paths/register -r ts-node/register src/**/*.test.ts src/**/**/*.test.ts src/**/**/**/*.test.ts",
-    "test-this": "mocha --recursive --timeout 30000 -r tsconfig-paths/register -r ts-node/register",
-    "debug": "tsc && node --inspect-brk=0.0.0.0:9229 dist/server.js",
-    "debug-this": "npm run build && mocha --inspect-brk=0.0.0.0:9229 --timeout 3000000 -r ts-node/register"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC"
-}

package/dist/templates/mxw-base-api-express/src/app-service.test.ts

@@ -1,94 +0,0 @@
-'use strict';
-
-import { describe, it, beforeEach, afterEach } from 'mocha';
-import { expect } from 'chai';
-import Sinon from "sinon";
-import AppService from './app-service';
-
-let sandbox: Sinon.SinonSandbox;
-
-describe('Suite: Endpoint - App Service', () => {
-    beforeEach(() => {
-        sandbox = Sinon.createSandbox();
-    });
-
-    afterEach(() => {
-        if (sandbox) {
-            sandbox.restore();
-            sandbox = undefined;
-        }
-    });
-
-    describe("Initialization", async () => {
-        it("Initialize service", async () => {
-            sandbox.stub(process, "env").get(() => {
-                return {
-                    JWT_SECRET: "secret",
-
-                    SERVICE_DOMAIN: "default",
-                    SERVICE_SESSION_TIMEOUT: 6000,
-                    SERVICE_WALLET_JSON: "hello",
-                    SERVICE_WALLET_PASSWORD: "world",
-
-                    MYSQL_URL: "hello mysql",
-
-                    CACHE_DIR: null,
-                    MAX_FILE_SIZE: null,
-
-                    MAX_REQUEST: 100
-                };
-            });
-
-            const instance = await AppService.init();
-
-            expect(instance).is.instanceOf(AppService);
-            expect(AppService.Instance).is.instanceOf(AppService);
-        });
-    });
-
-    describe("GET /readiness", async () => {
-        it("Service is ready", async () => {
-            const req: any = {
-                query: {}
-            };
-            const res: any = {
-                json: () => { }
-            };
-
-            const stubRes = sandbox.stub(res, "json").callsFake((body: any) => {
-                // console.log(JSON.stringify(body, null, 2));
-                expect(body).is.undefined;
-            });
-
-            await AppService.Instance["onReadiness"](req, res);
-
-            Sinon.assert.calledOnce(stubRes);
-        });
-    });
-
-    describe("GET /liveness", async () => {
-        it("Service is alive", async () => {
-            const req: any = {
-                query: {}
-            };
-            const res: any = {
-                json: () => { }
-            };
-
-            const stubRes = sandbox.stub(res, "json").callsFake((body: any) => {
-                // console.log(JSON.stringify(body, null, 2));
-                expect(body).is.undefined;
-            });
-
-            await AppService.Instance["onLiveness"](req, res);
-
-            Sinon.assert.calledOnce(stubRes);
-        });
-    });
-
-    describe("Termination", async () => {
-        it("Terminate service", async () => {
-            await AppService.term();
-        });
-    });
-});