Giter VIP home page Giter VIP logo

fortran-unit-test's Introduction

Fortran Unit Test Library FUT

Content

Overview

This is a Fortran Unit Test library purely written in Fortran to encourage scientific programmer to write tests.

Go to Top

Installation

A CMake-Setup is provided.

Go to Top

Example

demo.F90:

program good_test

  use unit_test

  implicit none

  type(test_suite_type) :: specific_suite

  ! example with default suite
  call test_suite_init()
  call test_case_create('Test 1')

  ! By sending macros __FILE__ and __LINE__, report will print the file and line number where assertion fails.
  call assert_approximate(1.0, 2.0, __FILE__, __LINE__) ! line 14

  ! report the complete suite
  call test_suite_report()

  ! finalize
  call test_case_final()

  ! example with specific suite
  call test_suite_init('my specific test suite', specific_suite)
  call test_case_create('Specific Test 1', specific_suite)
  ! suite = SUITE need in this case (cause optional argument eps, file_name, line_number is missing)
  call assert_approximate(1.0, 2.0, suite=specific_suite)

  call test_case_create('Specific Test 2', specific_suite)
  ! suite = SUITE need in this case (cause optional argument eps is missing)
  call assert_equal(1.0, 2.0, __FILE__, __LINE__,  suite=specific_suite)

  call test_case_create('Specific Test 3', specific_suite)
  call assert_approximate(1.0, 2.0, __FILE__, __LINE__, 1E-0, specific_suite)

  ! report a test_case
  call test_case_report('Specific Test 2', specific_suite)

  ! report the complete suite
  call test_suite_report(specific_suite)

  ! finalize
  call test_suite_final(specific_suite)

end program good_test

Output:

///////////////////// Report of Suite: Default test suite ///////////////////////

 +-> Details:
 |   |
 |   +-> Test 1: 1 of 1 assertions succeed.
 |   |
 |
 +-> Summary:
 |   +-> Default test suite: 1 of 1 assertions succeed.

////////////////////////////////////////////////////////////////////////////////


//////// Report of Suite: my specific test suite, Case: Specific Test 2 /////////

 +-> Specific Test 2: 0 of 1 assertions succeed.
 |   |
 |   +-> Assertion #1 failed with reason: x ( 1.000) == y ( 2.000)
 |   +-> Check line: test_assert.F90:29

/////////////////// Report of Suite: my specific test suite /////////////////////

 +-> Details:
 |   |
 |   +-> Specific Test 1: 1 of 1 assertions succeed.
 |   |
 |   +-> Specific Test 2: 0 of 1 assertions succeed.
 |   |   |
 |   |   +-> Assertion #1 failed with reason: x ( 1.000) == y ( 2.000)
 |   |   +-> Check line: test_assert.F90:29
 |   |
 |   +-> Specific Test 3: 0 of 1 assertions succeed.
 |   |   |
 |   |   +-> Assertion #1 failed with reason: x ( 1.000) =~ y ( 2.000)
 |   |   +-> Check line: test_assert.F90:32
 |   |
 |
 +-> Summary:
 |   +-> my specific test suite: 1 of 3 assertions succeed.

////////////////////////////////////////////////////////////////////////////////

You can integrate this library into your CMake based project as:

...
add_subdirectory (<fortran-unit-test root>)
include_directories (${UNIT_TEST_INCLUDE_DIR})
...
target_link_libraries (<user target> fortran_unit_test ...)

Go to Top

Supported Data Types

  • assert_equal()
    • single data type
      • integer(1);
      • integer(2);
      • integer(4);
      • integer(8);
      • real(4);
      • real(8);
      • character(*);
    • vector data type
      • integer(1), dimension(:);
      • integer(2), dimension(:);
      • integer(4), dimension(:);
      • integer(8), dimension(:);
      • real(4), dimension(:);
      • real(8), dimension(:);
      • character(*), dimension(:);
    • array data type
      • integer(1), dimension(:, :);
      • integer(2), dimension(:, :);
      • integer(4), dimension(:, :);
      • integer(8), dimension(:, :);
      • real(4), dimension(:, :);
      • real(8), dimension(:, :);
      • character(*), dimension(:, :);
  • assert_approximate()
    • single data type
      • real(4);
      • real(8);
    • vector data type
      • real(4), dimension(:);
      • real(8), dimension(:);
    • array data type
      • real(4), dimension(:, :);
      • real(8), dimension(:, :);
  • assert_great_then()
    • single data type
      • integer(1);
      • integer(2);
      • integer(4);
      • integer(8);
      • real(4);
      • real(8);
    • vector data type
      • integer(1), dimension(:);
      • integer(2), dimension(:);
      • integer(4), dimension(:);
      • integer(8), dimension(:);
      • real(4), dimension(:);
      • real(8), dimension(:);
    • array data type
      • integer(1), dimension(:, :);
      • integer(2), dimension(:, :);
      • integer(4), dimension(:, :);
      • integer(8), dimension(:, :);
      • real(4), dimension(:, :);
      • real(8), dimension(:, :);

Go to Top

Compiler Support

Compiler Compiler Compiler Compiler Compiler Compiler

Go to Top

License

License

Go to Top

fortran-unit-test's People

Contributors

cjarvers avatar dongli avatar jhenneberg avatar zhenkunl avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

fortran-unit-test's Issues

Print file name and line number

Currently, we only print the number of assertion in a test case, but it is impractical to count the number when there are many assertions, so we need to print the line number of the failed assertion in which file.

I am testing this feature with macros.

License Information

Hi,

I would like to use this repo in my own projects. Could you add licensing information to the project (optimally, some open source license)?

Cheers

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.