CS3219 OTOT Task B

Please visit the .pdf I have submitted in LUMINUS for clearer instructions and images

Task B1

Setup and Run for Task B1 and B2

You are required to download and install Node.js, PostgreSQL (with pgAdmin) and Postman.
Clone this repository by git clone https://github.com/WillySeahh/taskb.git
Navigate to the root directory by cd taskb.
Run npm install to install all the required dependencies to run this application.
Run pgAdmin applicaton to start the database and create a new Database name task-b in pgAdmin.
Run node server.js to start the application.
Afterwards, we can start accessing the API through the Postman.

Local Testing using Postman:
(Please refer to my submitted doc for a clearer view and I have included photos so that it will be easy for users to follow)

Get all quotes

Enter localhost:3000/api/quotes -> Select GET -> Click Send

You should get the list of all quotes. If the database is empty, it will return an empty array.

Create a new quote

Enter localhost:3000/api/quotes -> Select Body Tab -> Select raw -> Select Json -> Fill in the “title”, “author”, “description” -> Select Post -> Click Send

You should get the detail of the new quote.

Get a specific quote

Enter -> localhost:3000/api/quotes/{id} -> Replace {id} with the id of the quote -> Select Get -> Click send

You should get the detail of this specific quote.
If quote doesn’t exist, it will return a message saying quote with id do not exist.

Update a quote

Enter -> localhost:3000/api/quotes/{id} -> Replace {id} with id of the quote -> Select Body Tab -> Select raw -> Select Json -> Fill in the new “title”, “author”, “description” -> Select Put -> Click send

You should get the message of quote was updated successfully.

If the id is invalid, you will be informed as well.

Delete a quote

Enter -> localhost:3000/api/quotes/{id} -> Replace {id} with id of the quote -> Select Delete -> Click Send

You should receive a message saying quote is deleted successfully.

Delete all quotes

Enter -> localhost:3000/api/quotes -> Select Delete -> Click Send

You should get the message of total number of quotes was deleted successfully.

For deployed endpoint testing refer to B3 below. B3 is where I’ve done by deploying as such the deployed testing is done there.

Task B2

Write simple test cases for API and use a CI tool (Travis CI) to automate testing.

The test cases are created by Mocha and Chai.
(Please refer to my submitted doc for a clearer view and I have included photos so that it will be easy for users to follow)

Run test locally

Ensure you have Done Steps 1-5 of setup (at page 1 of this document)
Run npm test to run test case through Mocha

Run test through Travis CI

Ensure you have push this repository to your Github.
Go to Travis CI.
Login through the Github account.
Go to Travis CI Setting page, under Repositories tab, click Manage repositories on Github.
Under Repository access, either select All repositories or only select this repository on you Github.
Now, you can edit README.md and push it to your repository.
You should check the Travis CI to check the status of test on travis.

Task B3

Use CD tool for automated deployment to a serverless service.

This task using AWS Lambda as serverless service and Travis CI for automatic deployment.

Postman Testing with serverless service (Continued from B1 where they said “successful deployed endpoints”)

Please refer to my submitted doc for a clearer view and I have included photos so that it will be easy for users to follow

This section will show how to use Postman to test the APIs from deployment using Lambda.

The steps for testing with AWS Lambda is same as Postman testing locally except the URL will be different. You are required to use https://kv2wuhd9ll.execute-api.ap-southeast-1.amazonaws.com/dev/api/quotes/ instead of http://localhost:3000/api/quotes when you are accessing Get all quotes, Create a new quote and Delete all quotes.

You are required to use https://kv2wuhd9ll.execute-api.ap-southeast-1.amazonaws.com/dev/api/quotes/{id} instead of http://localhost:3000/api/quotes/{id} when accessing Get a specific quote, Update a quote and Delete a quote.

Setup Travis with AWS Credentials for CD

Whenever I push my code to github, travis will automatically run tests and then afterwards deploy my code.

Ensure the code is pushed to Guthub
Go to Travis CI
Select taskb tab and click on more options and choose settings.
Under Environment variable enter AWS ACCESS KEY AND SECRET KEY; stated in the pdf

Sample of Quote for you to copy paste and test

Post: http://localhost:3000/api/quotes Make sure to select Body tab, select raw and change data to JSON format { "title": "online friday test", "author": "online friday test", "description" : "nline friday test" }

WillySeahh / taskb