feat: end-to-end tests for core modules and idempotency

[jeromevdl]

Description of changes:

Adding end-to-end tests (happy path) for core modules (logging, metrics, tracing) and idempotency. Leverage AWS CDK + S3 and CloudFormation SDK to deploy a Lambda function and the appropriate infrastructure (ex: DDB table for idempotency).

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• PR title follows conventional commit semantics

Breaking change checklist

RFC issue #:

• Migration process documented
• Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[jeromevdl]

For some reason I don't explain, I cannot set the GitHub Action for e2e tests. I pause on this, already spent too much time.
@msailes if you wanna give a try... Also if you can review the code, and test locally.

This is what I used:

name: Run end-to-end tests

on:
  workflow_dispatch:

  pull_request: # temporary for testing the workflow itself
    branches:
      - master
    paths:
      - 'powertools-e2e-tests/**'
      - '.github/workflows/**'

  push:
    branches: [master]
    paths: # add other modules when there are under e2e tests
      - 'powertools-e2e-tests/**'
      - 'powertools-core/**'
      - 'powertools-serialization/**'
      - 'powertools-logging/**'
      - 'powertools-tracing/**'
      - 'powertools-idempotency/**'
      - 'powertools-metrics/**'
      - 'pom.xml'
      - '.github/workflows/**'

jobs:
  e2e:
    runs-on: ubuntu-latest
    env:
      JAVA_VERSION: ${{ matrix.java }}
      AWS_DEFAULT_REGION: eu-west-1
    permissions:
      id-token: write # needed to interact with GitHub's OIDC Token endpoint.
      contents: read
    strategy:
      max-parallel: 2
      matrix:
        java: [ 8, 11 ]
    name: End-to-end tests ${{ matrix.java }}
    steps:
      - uses: actions/checkout@v3
      - name: Setup java
        uses: actions/setup-java@v3
        with:
          distribution: 'corretto'
          java-version: ${{ matrix.java }}
          cache: maven
      - name: Setup AWS credentials
        uses: aws-actions/configure-aws-credentials@master
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_ARN_TO_ASSUME }}
          role-session-name: AWSSession
          aws-region: ${{ env.AWS_DEFAULT_REGION }}
      - name: Run e2e test with Maven
        run: mvn -Pe2e -B verify --file powertools-e2e-tests/pom.xml

And the error : aws-actions/configure-aws-credentials#460.

[scottgerring]

@jeromevdl some quick initial feedback to get the ball rolling. I need to dive a bit deeper into this still.

[scottgerring]

Does the powertools test suite otherwise run on windows?

[jeromevdl]

Good question... I don't know!

[scottgerring]

it does - tested quickly on windows - do we want to maintain that?

[scottgerring]

Hey @jeromevdl i've gone through the whole PR now and marked up some bits. Let me know if I there's anything else I can do to help.

[jeromevdl]

We have our answers, obviously it cannot work on java 8... 🤬 Will have to make it compatible 😫

[scottgerring]

LGTM!

[scottgerring]

For some reason I don't explain, I cannot set the GitHub Action for e2e tests. I pause on this, already spent too much time. @msailes if you wanna give a try... Also if you can review the code, and test locally.

This is what I used:

name: Run end-to-end tests

on:
  workflow_dispatch:

  pull_request: # temporary for testing the workflow itself
    branches:
      - master
    paths:
      - 'powertools-e2e-tests/**'
      - '.github/workflows/**'

  push:
    branches: [master]
    paths: # add other modules when there are under e2e tests
      - 'powertools-e2e-tests/**'
      - 'powertools-core/**'
      - 'powertools-serialization/**'
      - 'powertools-logging/**'
      - 'powertools-tracing/**'
      - 'powertools-idempotency/**'
      - 'powertools-metrics/**'
      - 'pom.xml'
      - '.github/workflows/**'

jobs:
  e2e:
    runs-on: ubuntu-latest
    env:
      JAVA_VERSION: ${{ matrix.java }}
      AWS_DEFAULT_REGION: eu-west-1
    permissions:
      id-token: write # needed to interact with GitHub's OIDC Token endpoint.
      contents: read
    strategy:
      max-parallel: 2
      matrix:
        java: [ 8, 11 ]
    name: End-to-end tests ${{ matrix.java }}
    steps:
      - uses: actions/checkout@v3
      - name: Setup java
        uses: actions/setup-java@v3
        with:
          distribution: 'corretto'
          java-version: ${{ matrix.java }}
          cache: maven
      - name: Setup AWS credentials
        uses: aws-actions/configure-aws-credentials@master
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_ARN_TO_ASSUME }}
          role-session-name: AWSSession
          aws-region: ${{ env.AWS_DEFAULT_REGION }}
      - name: Run e2e test with Maven
        run: mvn -Pe2e -B verify --file powertools-e2e-tests/pom.xml

And the error : aws-actions/configure-aws-credentials#460.

@jeromevdl the one question I have is - did you get this running in the github builds in the end?

[jeromevdl]

@jeromevdl the one question I have is - did you get this running in the github builds in the end?

@scottgerring Nope, was not working... I don't know why, if you want to have a look.

[mriccia]

LGTM

[mriccia]

Looks good