Facet API

Getting started

Creating an executable zip file and uploading the file via terraform to AWS.

1. Run make:

cd /src/facet/api
make

2. Run AWS Serverless Application Model (SAM) from the root directory of the project:

sam local start-api --port 3002 --env-vars env.json

3. Terraform is called a GH action.

Run tests

go test

Access JMeter results produced through CI

You can access JMeter tests via the S3 link: https://cdn.facet.ninja/test/api/regression/PUT_THE_CI_NUMBER_HERE/index.html, i.e: https://cdn.facet.ninja/test/api/regression/88/index.html.

Environment Variables

Environment variables are declared in both SAM (local development) and terraform modules (all the other environments). These are the steps to declare an environment variable:

1. Declaring the variable under Parameters:

  MY_VARIABLE:
    Type: String
    Description: An example variable
    Default: This is the default example

2. Passing it into the lambda environment by reference:

Environment:
    Variables:
      MY_VARIABLE: !Ref MY_VARIABLE

3. Adding the actual value in env.json:

{
  "API": {
    "MY_VARIABLE": "This variable was loaded from env.json"
  }
}

4. Reading it in the application:

fmt.Println(os.Getenv("MY_VARIABLE"))

5. Declaring it in the terraform module lambda.tf:

environment_variables = {
    MY_VARIABLE = "This variable was loaded in Terraform"
  }

Read here for more about this pattern.

Everytime there is an environment variable change, please add its name and description at env-example-template.json.

System requirements

Go: 1.15.2
Java: 15
Docker desktop: 2.5
TF version: 0.13.5

Terraform Deployment

For deploying to the test environment, run terraform apply with current directory being ./deploy. You will need to have preconfigured SSH keys to access GH repos. Follow this guide to generate SSH keys and upload them to GH.

Local Website Debugging (mutation-observer script)

Setup Tomcat server for locally debugging the https://github.com/facets-io/my-website-facets.io. Use Intellij's Artifact plugin and run it through the Tomcat debugger. Change the hosts file to map localhost with an example domain i.e.: 127.0.0.1 example-website.facet.run.