Adding pipeline

Author: javieraviles

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on:
+  push:
+    branches:    
+      - master
+
+jobs:
+  integration_tests:
+    name: Run integration tests
+    runs-on: ubuntu-16.04
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+    - name: Install Newman
+      run: npm install -g newman
+    - name: Integration Tests
+      run: cd src && npm run test:integration

README.md

@@ -14,6 +14,7 @@ Example REST API using the serverless stack from AWS: **Lambda, DynamoDB, SAM, A
     - [Post](#post)
     - [Comment](#comment)
   - [Integration Tests](#integration-tests)
+  - [Github Actions pipeline](#github-actions-pipeline)
 
 ## Available endpoints:
 | Method | Resource                             |
@@ -161,12 +162,33 @@ Properties:
 ```
 
 ## Integration Tests
-Find inside directory `integrationtests` a straightforward postman collection, including test assertions, testing every endpoint and a main application flow:
+Find inside directory `src/integrationtests` a straightforward postman collection, including test assertions, testing every endpoint and a main application flow:
 1. Create a Post
 2. Get all available Posts
 3. Get a specific Post checking structure
 4. Modify the Post's nickname
 5. Get it again to check whether it was modified correctly
 6. Add a Comment to the Post
 7. Delete the Comment
-8. Delete the Post
+8. Delete the Post
+
+To run them, you have basically two options:
+- Import the collection in Postman and run them manually
+- Install Newman `npm install -g newman` and execute `npm run test:integration`
+
+## Github Actions pipeline
+A very simple actions pipeline is provided in this project too. The file `.github/workflows/ci.yml` will create a pipeline which will trigger the postman collection automatically using newman against the production url for the api:
+```
+integration_tests:
+    name: Run integration tests
+    runs-on: ubuntu-16.04
+    steps:
+    - uses: actions/checkout@master
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+    - name: Install Newman
+      run: npm install -g newman
+    - name: Integration Tests
+      run: cd src && npm run test:integration
+```

integrationtests/postman.json renamed to src/integrationtests/postman.json

@@ -2,6 +2,9 @@
   "name": "serverless-aws",
   "version": "1.0.0",
   "description": "Serverless DynamoDB API in AWS using lambdas",
+  "scripts": {
+    "test:integration": "newman run integrationtests/postman.json"
+  },
   "author": "Javier Aviles",
   "license": "Apache-2.0",
   "dependencies": {