Adding the plugin to the $fish_plugins global variable declared in your fish configuration file, usually in ~/.config/fish/config.fish.
Directly importing the library into your fish file via import.

As of now, the most common use case is the second method, as you will probably want to test your own plugins or libraries.

Inside your project's directory create a new spec folder (recommended) and add all your spec files inside. Spec files are regular fish files that must look like *.spec.fish and contain your tests.

You can have multiple spec.fish files to organize your tests in a per module basis, or you can squash everything into a single file and use describe blocks to separate groups of tests.

A spec.file usually looks like this:

import plugins/fish-spec
import path/to/the-library # plugins/the-library

# Use -d to enter a friendly description (optional)
function describe_library -d "the grand library"

  function before_all
  # Optional. Runs only once before all the tests.
  end

  function after_all
  # Optional. Runs only once after all the tests.
  end

  function before_each
  # Optional. Runs once before each test.
  end

  function after_each
  # Optional. Runs once after each test.
  end

  function it_does_this
    # ...
    expect $what_I_got --to-equal $what_I_wanted
  end

  function it_does_that
    # ...
    expect $a_list --to-contain-all $expected_items
  end

  # ...
end

# Run tests when this file is sourced.
spec.run $argv

API

As of now, there is only one method you should be aware of, expect:

Assert a list of expected values match an actual value/s.

Under the hood, expect checks an actual value, usually a relevant result from your test unit, is equal to, not equal to, etc., to an expected value, as determined by your test. Below are the list of conditions available to use with expect:

--to-equal <actual> value equals <expected> value
--to-not-equal <actual> value does not equals <expected> value
--to-contain-all all <actual> values exist in <expected> list
--to-not-contain-all all <actual> values does not exist in <expected> list
--to-be-true exit status should be truthy
--to-be-false exit status should be falsy

FAQ

How to use fish-spec without Oh-My-Fish? fish-spec is still a work in progress and as it currently stands, it is only available bundled with Oh-My-Fish. As the library matures and grows, however, it is possible a future guide describing how to export fish-spec will be written.

Authors

License

MIT