GithubHelp home page GithubHelp logo

bgonibeedu / specflow-takedown Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mbarrett/specflow-takedown

0.0 0.0 0.0 180 KB

Acceptance testing a REST API using C# and SpecFlow.

C# 79.38% Gherkin 14.39% Batchfile 6.24%

specflow-takedown's Introduction

specflow-takedown

A clean and cutdown template for writing acceptance tests against API endpoints.

##Setup

Ensure you have installed the Visual Studio integration packages for Specflow as documented here http://www.specflow.org/getting-started.

##Usage

To run an acceptance test:

  • Build solution
  • Open desired feature file located within 'Features' folder
  • Right click a feature or scenario title
  • Click 'Run Specflow Scenarios'

Or even better use the command line to run all the tests:

  • Navigate to the root of the specflow-takedown project (cd [file_location]\specflow-takedown\api-acceptance-tests)
  • Execute the command line test runner by typing 'runtests.cmd' and hit [Enter]

##Auto generated documentation

Running acceptance tests via the CLI means we can generate some useful reports and documentation.

SpecRun provides a nice reporting structure for your acceptance tests. These reports can be found within the 'TestResults' folder. More information on SpecRun reporting here http://www.specflow.org/documentation/Reporting/.

Pickles is a tool that will output features as human readable documentation. These files are generated within the 'Documentation' folder. More information on Pickles reporting here http://docs.picklesdoc.com/en/latest/StartSimple/

It is recommended that any generated reports should be downloadable artifacts generated by your automated build process.

##Troubleshooting

The acceptance tests make a GET request to various endpoints within jsonplaceholder.typicode.com. In case of request timeouts please check your connection to jsonplaceholder.typicode.com.

##Credits

Shout outs to Specflow, SpecRun, Shouldly and EasyHttp.

specflow-takedown's People

Contributors

mark-barrett-gh avatar mbarrett 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.