in your ci api testing pipeline - continuous lifecycle london · 2020. 10. 19. · servicestack...

[email protected]

API Testing in your CI Pipeline

Jason Smith

Senior Engineer

Container Solutions

@jasonrichardsmi@containersoluti

www.container-solutions.com [email protected]

The Three Things

● Specifications

● Testing your API

● Mocking your API


19 Nov 1863


Now


IDL (Interface Description Language)

J. R. NestorW. A. WulfD. A. Lamb

August 1981Carnegie-Mellon UniversityComputer Science Department



In order to work together harmoniously, ... programs ... must have a precise and compatible definition of the data structures they use to communicate with each other.



● Precision

● Representation Independence

● Language Independence

● Maintainability

● Communication Form


SOAP

WSDL


REST

Tony Tam recounts the history of Swagger and the Open API Initiative

http://www.youtube.com/watch?v=oxqZ9J6t420&t=110


REST

Not standardized...


OpenAPI Specification

Formerly Swagger

Open API Initiative(Linux Foundation)


Other Major Players

API Blueprint

RAML


YAML!


So many toolssswagger-jsswagger-uiswagger-toolsswagger-editorswagger-coreswagger-parserswagger-codegenswagger-nodevalidator-badgering-swaggercompojure-apifnhouse-swaggerpedestal-swaggerswagger1stFribooswagger-sdkcbSwaggerswaggerizecowboy-swaggerPhoenixSwaggergo-swaggergoagrpc-gatewayswagger2servant-swaggerassertj-swaggerbinder-swagger-javadropwizard-swaggerelidejooby-swaggerrestlet-frameworkspringfoxswagger-codegen-maven-pluginswagger2markupswagger2markup-gradle-pluginswagger-maven-pluginswagger-codegen-gradle-pluginswagger-request-validatorSwagger ParserJester - Jolie rEST routER

lua-SporeNSwagSwashbuckleSwashbuckle.AspNetCoreAutoRestSwaggerProviderNSwagQSwagSwaggerWcfNancy.Swaggera127api-spec-converterblueoak-serverexpress-openapifleek-parserfleek-responsefleek-routerfleek-validatorfury-adapter-swaggergenerator-swaggerizegot-swaghapi-swaggeredhippie-swaggeroas-nodegenpokemocksails-swaggerserverless_swaggerswagger-jsdocswagger-mongodbswagger-toolsswaggerize-expressswaggerize-hapiswagmockSwagger Express MiddlewareSwagger Parsertest2doc.jskoa-joi-swaggerRaisinSwagger2Swagger2::Client

Mojolicious::Plugin::Swagger2cakephp-swaggerSwagger-PHPSwaggerAssertionsphp-swaggerize-fastroute-librarySwaggerGenJane OpenAPIgossi/swaggercalcinai/strutfalsypyramid-swaggerflask-restpluspyswaggerflexFlasggerflask-swaggerbravadobravado-coreswagger-spec-validatorswagger-py-codegenConnexionpecan-swaggerswagger-parserswagger-testerswagger-aggregatorswagger-stubbottle-swaggerpranceApivoregrape-swaggerswagger-blocksswagger_enginesvelterspec-rails-swaggerrswagsbt-swagger-codegenplay-swaggerFintrospectSwagGenAPIs.guru

bootprint-swaggerDreddember-swagger-uigenerator-openapi-repointellij-swaggerlinter-swaggerReDocswagger-commanderswagger-confluenceswagger-diffswagger.edSwagDefGenvscode-apielementsember-swagger-uicommandcarSwagGenswagger-mock-validatorSpectacleoctohipsterswagger-docs-cfmlswaggergo-restfulSashaybeegoSwagger spec generatorrestapidocswaggydocswagger4spring-webswagger-jaxrs-docletswaggerj4swaggerapiswagger-validatorswagger-ajax-clientswagger-angular-clientswagger-client-generatorswagger-validateServiceStackfubumvc-swaggerdotswaggenSwagger Framework

swagger-jackhapi-swaggerSwagger Validationswagger-node-clientratifyswagger-expressNelmioApiDocBundleRestlerswagger-assertSwaggerveldjango-rest-swaggerdjango-tastypie-swaggerflask-restful-swaggerswagger-docssource2swaggerswagger_engineScalatraspray-swaggerApi-docgform-adminswagger-cli-clientSwagger2Postman


The Repo

https://github.com/ContainerSolutions/DreddDemo





+ =


The API

Swagger Editor

Swagger UI



Simple Server

Go (Gorilla Mux)

Special Handlers



Special Handlers

authMiddleware

NopeHandler


https://github.com/ContainerSolutions/DreddDemo/blob/master/main.go#L95-L106





The Three Things

● Specifications




Dredd

https://github.com/apiaryio/dredd

“Dredd reads your API description and step by step validates whether your API implementation replies with responses as they are described in the documentation.”




Dredd

dredd.yml

dry-run: nullhookfiles: dredd/hooks.jslanguage: nodejssandbox: falseserver: ./mainserver-wait: 2init: falsecustom: {}names: falseonly: []reporter: []output: []header: []...


Dredd Hooks

● POST > /items Requires Auth● GET > /nope returns error

https://github.com/ContainerSolutions/DreddDemo/blob/master/dredd/hooks.js

https://github.com/ContainerSolutions/DreddDemo/blob/master/dredd/hooks.js


Dredd

$dredd


Makefile

builddredd: @docker build -t dreddtest -f dredd/DockerDredd .

dreddtest: builddredd @docker run\ -e "DEMOSHASALT=test_salt"\ dreddtest


Run the test

$make dreddtest


Circle-CI

machine: services: - dockertest: override: - make dreddtest


Travis-CI

language: gogo: 1.6services:- dockerscript:- make dreddtest


Results

https://travis-ci.org/ContainerSolutions/DreddDemo

https://circleci.com/gh/ContainerSolutions/DreddDemo

https://semaphoreci.com/jasonrichardsmith/dredddemo

http://54.72.105.103:8080/job/DreddDemo/










The Three Things

● Specifications




Mocking your api


Pokemock

https://github.com/mobilcom-debitel/pokemock

Drakovhttps://github.com/Aconex/drakov



https://github.com/Aconex/drakov

https://github.com/Aconex/drakov


Pokemock

FROM node:7-alpine

RUN npm install -g pokemock

COPY apispec/spec.yml .COPY pokemock/runpokemock.sh .ENTRYPOINT /bin/sh runpokemock.sh


Let’s make it public

https://sloppy.io/

https://admin.sloppy.io/project/dredd-demo

https://admin.sloppy.io/project/dredd-demo


Those tests

Badges




What you get from the start

● A formal contract

● API testing

● A mock for consumer testing

Thank You!

Jason Smith

Senior Engineer

Container Solutions

@jasonrichardsmi

in your ci api testing pipeline - continuous lifecycle london · 2020. 10. 19. · servicestack...

Documents