mechanicalrock / beady-eye Goto Github PK

In order to get started quickly
As a Beady Eye user
I want to run a command to create a new BDI project from a template

Describe command "bready-eye create --from-template aws-nodejs-typescript --project spec/my-new-project":

describe "when project folder does not exist"
  it "should create spec/my-new-project"
  it "should create spec/my-new-project/serverless.yml"
  it "should create spec/my-new-project/package.json"
  it "should create spec/my-new-project/tsconfig.json"
  it "should create spec/my-new-project/tslint.json"
  it "should create spec/my-new-project/src/complianceTests.js"
  it "should create spec/my-new-project/src/myComplianceTest.js"

describe "when project folder already exists"
  it "should fail with an appropriate error message"
  it "should not create any resources"

In order to validate that mocked data is consistent with reality, there is currently approval test data generated using a real AWS environment.

But the setup is currently manual.

1. Perform appropriate setup/teardown to ensure that approval test data is consistent.

2. Scrub returned data where appropriate, to remove account numbers etc.

3. Consider running the tests against a simulated back end - e.g. Localstack.

4. requires the simulated back end to support all the features we need.

At the moment, aws-sdk is packaged as a node dependency. This unnecessarily bloats it's usage when packaged in a Lambda function.

Options:

• Use codependency to specify as an optional dependency
• Specify aws-sdk as a development dependency. This will cause issues if it is not used in Lambda functions, where the aws-sdk is already pre-packaged.

The current workaround is for the client to explicitly exclude it from packaging.
Example (Serverless Framework serverless.yml snippet)

  my-connection-test:
    handler:  src/connectionTester.connect
    package:
      # only include connection tester
      exclude:
        - src/**
        - node_modules/**
      include:
        - src/connectionTester.js
        - node_modules/beady-eye/**
       # exclude aws-sdk from packaging
        - '!node_modules/beady-eye/node_modules/aws-sdk/**'

Specs have been moved to subfolders based on the resource.

The test-module prefix on the filename is probably not required anymore.