Skip to content

Latest commit

 

History

History
142 lines (103 loc) · 3.68 KB

README.md

File metadata and controls

142 lines (103 loc) · 3.68 KB

Fable.Pyxpecto

Nuget

This repository is heavily inspired by Fable.Mocha by the awesome @Zaid-Ajaj.

Fable python library for testing. Inspired by the popular Expecto library for F# and adopts the testList, testCase and testCaseAsync primitives for defining tests.

pyxpecto

Features

Reuse Expecto/Fable.Mocha Tests

/// Reuse unit tests from Expecto and Fable.Mocha
let tests_basic = testList "Basic" [
    testCase "testCase works with numbers" <| fun () ->
        Expect.equal (1 + 1) 2 "Should be equal"

    testCase "isFalse works" <| fun () ->
        Expect.isFalse (1 = 2) "Should be equal"

    testCase "areEqual with msg" <| fun _ ->
        Expect.equal 2 2 "They are the same"

    testCase "isOk works correctly" <| fun _ ->
        let actual = Ok true
        Expect.isOk actual "Should be Ok"
]

Pending

Pending tests will not be run, but displayed as "skipped".

ptestCase "skipping this one" <| fun _ ->
    failwith "Shouldn't be running this test"

ptestCaseAsync "skipping this one async" <|
    async {
        failwith "Shouldn't be running this test"
    }

Focused

If there are any focused tests all other tests will not be run and are displayed as "skipped".

👀 Passing the --fail-on-focused-tests command line argument will make the runner fail if focused tests exist. This is used to avoid passing CI chains, when accidently pushing focused tests.

Example py my_focused_tests_file.py --fail-on-focused-tests will fail.

let focusedTestsCases =
    testList "Focused" [
        ftestCase "Focused sync test" <| fun _ ->
            Expect.equal (1 + 1) 2 "Should be equal"
        ftestCaseAsync "Focused async test" <|
            async {
                Expect.equal (1 + 1) 2 "Should be equal"
            }
    ]

Sequential Tests

Actually all tests run with this library will be sequential. The function is only added to comply with Expecto syntax.

Install

From Nuget with:

  • paket add Fable.Pyxpecto --version 0.0.0
  • <PackageReference Include="Fable.Pyxpecto" Version="0.0.0" />

Running tests

Use the following syntax to automatically switch between Expecto, Fable.Mocha and Pyxpecto:

#if FABLE_COMPILER_PYTHON
open Fable.Pyxpecto
#endif
#if FABLE_COMPILER_JAVASCRIPT
open Fable.Mocha
#endif
#if !FABLE_COMPILER
open Expecto
#endif
[<EntryPoint>]
let main argv =
    #if FABLE_COMPILER_PYTHON
    Pyxpecto.runTests all
    #endif
    #if FABLE_COMPILER_JAVASCRIPT
    Mocha.runTests all
    #endif
    #if !FABLE_COMPILER
    Tests.runTestsWithCLIArgs [] [||] all
    #endif

👀 Everything in curly braces are placeholders

  1. Transpile test project to python dotnet fable {path/to/tests} --lang py -o {path/to/tests}/py
  2. Run tests py {path/to/tests}/{EntryFileName.py}

Development

Requirements

  • Python
    • check with py --version (Tested with Python 3.11.1)
  • Dotnet SDK
    • check with dotnet --version (Tested with 7.0.306)
  • Node
    • check with node --version (Tested with v18.16.1)
  • npm
    • check with node --version (Tested with 9.2.0)

Setup

Run all commands in root.

  1. dotnet tool restore
  2. npm install

Routines

Tests

./build.cmd runtests

Can be specified to run tests for specific environment.

  • ./build.cmd runtestsdotnet
  • ./build.cmd runtestsjs
  • ./build.cmd runtestspy