Code Monkey home page Code Monkey logo

beady-eye's Introduction

Beady Eye

Behaviour Driven Infrastructure is the technique of describing the expected behaviour of infrastructure components to support the specification and test driven development of Infrastructure as Code.

Beady Eye is a testing framework to support Behaviour Driven Infrastructure on AWS components, to keep an eye on your infrastructure compliance!

Getting Started

Create your compliance test my-compliance-test.js: NOTE: compliance tests need to be .js

module.exports.suite = (params) => {
    describe("My Redshift Cluster", () => {
        let redshiftClusterName = 'my-redshift-cluster'

        beforeAll((done)=> {
        
            const bdi = require('beady-eye')
            const RedshiftCluster = bdi.RedshiftCluster
            
            this.redshift = new RedshiftCluster(redshiftClusterName, region)
            done()
        })

        it("should exist", async (done) => {
            expect(this.redshift).toBeDefined()
            expect(await this.redshift.shouldExist()).toEqual(true)
            done()
        })
    })
}

Configure your src/complianceTestLambda.ts:

export const runCompliance: Handler = (event: APIGatewayEvent, context: Context, cb: Callback) => {

  let complianceRunner = new JasmineComplianceRunner(cb)  

  require('./my-compliance-test.js').suite(redshiftParams)

  complianceRunner.execute()
}

Configure serverless.yaml:

functions:
  compliance:
    handler: src/complianceTests.runCompliance
    package:
      include:
        - src/*.js
        - node_modules/beady-eye/**

Development

git clone https://github.com/MechanicalRock/beady-eye
cd beedy-eye
npm install
npm link
cd /path/to/my/project
npm link beady-eye

Continuous Build

In order to build changes continuously, when working with linked projects, create a separate terminal and run:

npm run build:watch

This will automatically re-build upon changes to your beady-eye source, so it is available in your linked project.

Generating test data

Set the details of the account you wish to switch to for test data generation

export AWS_PROFILE='my_profile'
export AWS_ACCOUNT_ID='123456
npm run test:approval

Releasing

npm run release
git push
git push --tags

beady-eye's People

Contributors

raf-vgw avatar temyers avatar arullewis avatar richardforshaw avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.