Table of Contents

1. Serverless App test for Trend Micro
   • Built With Node.js, Serverless, JavaScript
2. Getting Started
   • Prerequisites
   • Installation

About The Project

This is a Serverless App using AWS SDK (Lambda, API Gateway, EC2) and retrieves a list of SecurityGroups from EC2

A. API Gateway + Lambda

1. Create a Serverless framework application. More info: https://www.serverless.com/framework/docs/

2. Create a Lambda to list all EC2 security groups in an AWS Account.

3. Make the Lambda function available via an AWS API Gateway endpoint.

4. Write unit tests for your code by mocking AWS EC2 API. Hint: You can use the aws-sdk-mock npm module

5. Produce a code coverage report for your test suite.

6. Secure the endpoint using a custom API Gateway Lambda Authoriser. More info: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html

7. Make response JSON:API 1.0 (https://jsonapi.org/format/1.0/) compatible.

(back to top)

Built With

• Node.js
• Serverless

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Run npm install to install the required packages for this repo

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/github_username/repo_name.git

2. Install NPM packages

   npm install

3. Generate temporary AWS credentials using aws sts assume-role
4. Create your own .env containing your AWS credentials (refer to example.env)
5. Run locally using npm run start

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Project Link: https://github.com/jpajar/trend-micro-test

(back to top)