Merge pull request #2 from lazyskulptor/master

README.md 작성

Author: lazyskulptor

.github/workflows/integration_javascript.yml

@@ -0,0 +1,64 @@
+name: Deploy production
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container: node:lts-slim
+    # 아래 defaults 의 run 설정은 node 루트 경로와 저장소 루트가 일치하지 않아 추가됨
+    # 일반 프로젝트에는 필요없음
+    defaults: 
+      run:
+        working-directory: javascript-example
+
+    # 서비스 아래의 rdb1, rdb2, cache 값은 다른 값으로 설정 가능하며 해당 서비스의 DOMAIN NAME 으로 사용됩니다.
+    # 모든 설정 방법은 docker 설정과 일치합니다. 에를 들어 port 값은 좌측은 외부 port 우측은 포워딩 되는 내부 포트입니다.
+    services:
+      rdb1:
+        image: postgres
+        ports:
+          - 5432:5432
+      rdb2:
+        image: mysql:5
+        env:
+          MYSQL_ROOT_PASSWORD: rootpassword
+        ports:
+          - 3306:3306
+      dynamodb:
+        image: amazon/dynamodb-local
+        ports:
+          - 8000:8000
+      cache:
+        image: redis:6
+        ports:
+          - 6379:6379
+
+    steps:
+    # 아래의 명령문들이 테스트를 하기 위한 설정 및 실행들 입니다. run 하나가 Linux 에서의 명령문입니다.
+      - uses: actions/checkout@v2
+
+      - name: setup node environment
+      # package-lock.json 파일이 저장소에 있을 때는 npm ci 명령어 사용 가능
+        run: npm install
+
+      - name: Install RDB Dependencies
+        run: apt-get update && apt-get install -y default-mysql-client
+
+      - name: Initialize RDB MySQL
+        run: mysql -h rdb2 -u root -prootpassword < dump.sql
+
+
+      - name: Initialize RDB Postgres
+        run: node .github/scripts/initialize_pg.js
+
+      - name: Build and Test
+        run: npx jest
+      # 상단의 services 에서 설정한 이름의 DOMAIN 값을 사용하기 위해 서비스 내부에 env 값을 설정해줍니다.
+      # 해당 값을 바라보기 위해선 node, django 서비스 에서 OS 의 env 값을 읽어오는 설정을 해야합니다.
+        env: 
+          DB_HOST: postgres
+          NOSQL_HOST: dynamodb
+          CACHE_HOST: cache
+
+      - name: Success
+        run: echo deployed successfully.

.github/workflows/integration_typescript.yml

@@ -0,0 +1,64 @@
+name: Deploy production
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container: node:lts-slim
+    # 아래 defaults 의 run 설정은 node 루트 경로와 저장소 루트가 일치하지 않아 추가됨
+    # 일반 프로젝트에는 필요없음
+    defaults: 
+      run:
+        working-directory: typescript-example
+
+    # 서비스 아래의 rdb1, rdb2, cache 값은 다른 값으로 설정 가능하며 해당 서비스의 DOMAIN NAME 으로 사용됩니다.
+    # 모든 설정 방법은 docker 설정과 일치합니다. 에를 들어 port 값은 좌측은 외부 port 우측은 포워딩 되는 내부 포트입니다.
+    services:
+      rdb1:
+        image: postgres
+        ports:
+          - 5432:5432
+      rdb2:
+        image: mysql:5
+        env:
+          MYSQL_ROOT_PASSWORD: rootpassword
+        ports:
+          - 3306:3306
+      dynamodb:
+        image: amazon/dynamodb-local
+        ports:
+          - 8000:8000
+      cache:
+        image: redis:6
+        ports:
+          - 6379:6379
+
+    steps:
+    # 아래의 명령문들이 테스트를 하기 위한 설정 및 실행들 입니다. run 하나가 Linux 에서의 명령문입니다.
+      - uses: actions/checkout@v2
+
+      - name: setup node environment
+      # package-lock.json 파일이 저장소에 있을 때는 npm ci 명령어 사용 가능
+        run: npm install
+
+      - name: Install RDB Dependencies
+        run: apt-get update && apt-get install -y default-mysql-client
+
+      - name: Initialize RDB MySQL
+        run: mysql -h rdb2 -u root -prootpassword < dump.sql
+
+
+      - name: Initialize RDB Postgres
+        run: node .github/scripts/initialize_pg.js
+
+      - name: Build and Test
+        run: npx jest
+      # 상단의 services 에서 설정한 이름의 DOMAIN 값을 사용하기 위해 서비스 내부에 env 값을 설정해줍니다.
+      # 해당 값을 바라보기 위해선 node, django 서비스 에서 OS 의 env 값을 읽어오는 설정을 해야합니다.
+        env: 
+          DB_HOST: postgres
+          NOSQL_HOST: dynamodb
+          CACHE_HOST: cache
+
+      - name: Success
+        run: echo deployed successfully.

README.md

@@ -0,0 +1,102 @@
+# express-jest
+
+## 깨끗한 테스트 코드 유지의 중요성
+* **테스트 코드는 실제 코드 못지 않게 중요하다.**
+* 테스트 코드에 실제 코드와 동일한 품질 기준을 적용해야 한다.  
+* 실제 코드가 진화하면 테스트 코드도 변해야 한다.
+
+## 깨끗한 테스트 코드 작성하기
+* 깨끗한 테스트 코드를 만들려면? 세 가지가 필요하다. **가독성, 가독성, 가독성.**  
+  * 어쩌면 가독성은 실제 코드보다 테스트 코드에 더더욱 중요하다.
+* **이중 표준**
+  * 실제 코드만큼 효율적일 필요는 없다.
+* 가독성을 위해 BUILD-OPERATE-CHECK 패턴이 자주 사용된다.
+  * [DB 사용을 위한 BOC 패턴을 위한 참조 링크](https://medium.com/swlh/usual-production-patterns-applied-to-integration-tests-50a941f0b04a)
+```javascript
+//BUILD  테스트를 위한 사전 준비를 한다.
+const userToInsert = prepareUser();
+
+//OPERATE 테스트할 코드를 실행한다.
+const userFromDB = await service.createUser(userToInsert);
+
+//CHECK 실행 결과를 확인한다.
+expect(userFromDB.username).toBe(userToInsert.username);
+expect(userFromDB.id).toBe(userToInsert.id);
+
+```
+
+## 테스트의 최종 목적지! TDD 그리고 BDD (테스트주도 개발, 행위주도 개발)
+### TDD 법칙 from [테스트 주도 개발], [클린코드]
+1. 어떤 코드건 작성하기 전에 실패하는 자동화된 테스트를 작성하라.
+    1. 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
+    2. 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
+    3. 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.
+2. 중복을 제거하라.
+### BDD, TDD 의 연장선으로서
+개발자, QA 와 비개발자 모두 한 팀으로 대화를 통해 구체적인 예시와 어떻게 어플리케이션이 작동해야 하는지 만들어가는 방법론입니다.  
+BDD 는 모든 단위 테스트들이 실사용자의 행동(유스케이스)에 의해 정의되는 것을 말합니다.  
+##### 예시
+> Not BDD
+> 1. DB 에 저장되어 있는 사용자 정보를 가져오면 여러 API 에서 사용할거라 가정
+> 2. 여러 API 에서 사용할 수 있도록 DB 에서 정보를 가져오는 서비스를 생성
+> 3. 서비스를 테스트하는 테스트를 만듬
+> 
+> BDD
+> 1. 사용자 로그인 기능이 필요
+> 2. 사용자가 할 수 있는 로그인 시도 케이스들을 테스트 코드로 작성  
+> ... 위에 적힌 TDD 에 맞게 실행함
+
+----  
+  
+  
+    
+# 샘플코드 안내  
+
+샘플코드는 javascript 와 typescript 두 가지로 나뉘어 제공됩니다.  
+공통되는 부분만 안내합니다. 추가적인 부분은 각 폴더의 README.md 참조 바랍니다. 
+
+## 단위 테스트는 [jest](https://jestjs.io/docs/getting-started) 를 사용함 
+```bash
+# 전체 테스트 실행  
+$ jest  
+# 원하는 테스트만 실행. <describeString> 는 테스트 그룹, <itString> 는 테스트 이름으로 대체합니다.  
+$ jest -t '<describeString> <itString>'  
+```
+
+## endpoint 테스트에 [supertest](https://github.com/visionmedia/supertest#readme) 를 사용함  
+```javascript
+/** 
+ * 반드시 done 함수를 파라미터로 주거나 async 함수를 사용해아 합니다.
+ * 그렇지 않을 경우 테스트가 프로세스가 멈추지 않습니다.
+*/ 
+
+// callback
+it('', (done) => {
+request.get('/')
+        .expect(200)
+        .end(done);
+})
+
+// OR aync
+it('', async () => {
+  await request.get('/')
+          .expect(200)
+          .end();
+})
+```
+
+## CI, CD 환경
+실서버와 같은 DB 를 새로 구성해 테스트 합니다.   
+그러므로 로컬에서도 Mocker 보다 실제 DB 를 사용한 테스트를 권장합니다.  
+
+`[GIT_ROOT]/.github/workflows/` 경로에 스크립트가 있어야 합니다.  
+해당 샘플의 경우 한 저장소에 두 프로젝트가 있지만 일반적인 경우 프로젝트 루트에 .github 폴더가 위치해야 합니다.  
+javascript, typescript 를 위한 스크립트 동일하게 제작됐습니다.  
+
+CI/CD 는 docker 기반으로 사용되기 때문에 사용되는 이미지 별로 환경변수와 명령어들을 위해 docker hub 에서 문서를 참조하는 것이 좋습니다.  
+해당 스크립트에선 [node](https://hub.docker.com/_/node), [mysql](https://hub.docker.com/_/mysql), [postgres](https://hub.docker.com/_/postgres), [dynamodb](https://hub.docker.com/r/amazon/dynamodb-local/), [redis](https://hub.docker.com/_/redis) 이미지가 사용됐습니다.  
+
+----
+##### 참고문헌
+[클린코드] Robert C. Martin  
+[테스트 주도 개발] Kent Beck

javascript-example/.github/scripts/initialize_pg.js

@@ -0,0 +1,6 @@
+const { Client } = require('pg');
+
+const DB_HOST = process.env.DB_HOST;
+const DB_PORT = process.env.DB_PORT || '5432';
+
+//TODO: initialize pgsql.

javascript-example/__tests__/__mocks__/repositories/UserRepoMock.js

@@ -0,0 +1,34 @@
+const UserRepo = require('@/repositories/UserRepo').UserRepo;
+const data = [];
+
+exports.UserRepoMock = class UserRepoMock extends UserRepo{
+  constructor() {
+    super();
+  }
+  
+  async insertUser(user) {
+    const isExist = data.find(rw => {
+      return user.username === rw.username
+    });
+    if(!isExist) {
+      user.id = String(data.length + 1);
+      data.push(user);
+    } else {
+      throw new Error('Duplicate username');
+    }
+    
+    return data.find(
+      rw => user.username === rw.username
+    );
+  }
+  
+  async findUserByUsername(username) {
+    return data.find(
+      rw => username === rw.username
+    );
+  }
+  
+  truncate() {
+    data.length = 0;
+  }
+}

javascript-example/__tests__/__mocks__/userMocks.js

@@ -0,0 +1,23 @@
+
+const initUser = function createRandomUser() {
+  return {
+    username: randomStr(16),
+    name: 'asdf',
+    password: 'asdf'
+  }
+}
+
+const randomStr = function createRandomStr(len) {
+  const eleList = 'ABCDEFHIJKLMNOPQRSTUVXYZabcdefhijklmnopqrstuvxyz';
+  let result = '';
+  Array(len).fill(0).forEach((_, i) => {
+    const random = Math.floor(Math.random() * 48)
+    result += eleList[random];
+  });
+  return result;
+}
+
+module.exports = {
+  initUser,
+  randomStr
+}

javascript-example/__tests__/basic-test-sample.js

@@ -0,0 +1,13 @@
+const app = require('@/app');
+
+test('null', () => {
+  const n = null;
+  console.log(123);
+  expect(n).toBeNull();
+});
+
+//it() 은 test() 의 alias 로 똑같은 함수입니다.
+//Test to import file by alias path
+it('mount app', () => {
+  app;
+})

javascript-example/__tests__/ci-test/auth-flow-ci.js

@@ -0,0 +1,62 @@
+const app = require("@/app").express;
+const supertest = require("supertest");
+const userMocker = require("@test/__mocks__/userMocks");
+const initUser = userMocker.initUser;
+const userService = require("@/services");
+
+const request = supertest(app);
+
+describe('test endpoint', () => {
+  let usrService = userService.userService;
+  let userRepo = usrService.repo;
+  console.log(userRepo);
+  
+  beforeAll(()=>{
+    //COMMON BUILD
+  });
+  
+  // Callback 방식
+  it('', (done) => {
+    request.get('/')
+      .expect(200)
+      .end(done);
+  })
+  
+  // Async 방식
+  it('CI 실패, 로그인 시도', async () => {
+    await request.post('/signin')
+      .send({username: 'test', password: '1234'})
+      .set('Accept', 'application/json')
+      
+      
+      .expect((res) => {
+        res.body = {result: res.body.result}
+      })
+      .expect(200, {
+        result: false
+      });
+  })
+  
+  it('CI 성공, 로그인 시도', async () => {
+    const user = initUser();
+    await userRepo.insertUser(user);
+    
+    
+    await request.post('/signin')
+      .send(user)
+      .set('Accept', 'application/json')
+      
+      
+      .expect((res) => {
+        res.body = {result: res.body.result}
+      })
+      .expect(200, {
+        result: true
+      });
+    
+  })
+  
+  afterAll(() => {
+    userRepo.truncate();
+  })
+})