Giter Club home page Giter Club logo

btk's Introduction

Bash ToolKit

Unittests and Code Coverage for Bash Script (inspired by shcov and shunit2).

This package contains:

  • btkut: perform UnitTests
  • btkcc: generate code coverage

Install

build RPM

Before making any changes, make sure you update the "Release" target in the .spec file.

First, create .tar.gz:

cd /path/to/build/SOURCE
tar czf btk.tar.gz btk/

And build the rpm file

cd /path/to/build/
rpmbuild --define "_topdir $(pwd)" -ba SPECS/btk.spec

Install RPM

$ sudo rpm -ivh BTK-1-0.0.noarch.rpm

Usage

btkut

To run tests, add this at the end of the file of your script_test.sh

. btkut

Example

#!/bin/bash

function_x_test()
{
    # some tests
    assertTrue "$?"
}

. btkut

btkcc

To generate the code coverage report, we need first to generate the data.

$ btkcc bash_script.sh

Then, generate the report

$ btkcc --report

This will generate a report that can be open via this URL:

file:///tmp/btk/report/index.html

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.