Admin at 21:39, 28 November 2024

2024-11-28T21:39:39Z

← Older revision		Revision as of 21:39, 28 November 2024
Line 7:		Line 7:
	A Bats test file is a Bash script with special syntax for defining test cases. Under the hood, each test case is just a function with a description.		A Bats test file is a Bash script with special syntax for defining test cases. Under the hood, each test case is just a function with a description.

	<~~pre~~>#!/usr/bin/env bats		<syntaxhighlight lang="bash" line>
			#!/usr/bin/env bats

	@test "addition using bc" {		@test "addition using bc" {
	result="$(echo 2+2 \| bc)"		result="$(echo 2+2 \| bc)"
	[ "$result" -eq 4 ]		[ "$result" -eq 4 ]
	}</~~pre~~>		}
			</syntaxhighlight>

	(The above overview section was stolen verbatim from [https://github.com/sstephenson/bats the main projects README]).		(The above overview section was stolen verbatim from [https://github.com/sstephenson/bats the main projects README]).
Line 35:		Line 37:
	<code>test.bats</code>		<code>test.bats</code>

	<~~pre~~>		<syntaxhighlight lang="bash" line>
	#!/usr/bin/env bats		#!/usr/bin/env bats

Line 51:		Line 53:
	assert_equal "$(basename $BATS_TEST_FILENAME)" 'test.bats'		assert_equal "$(basename $BATS_TEST_FILENAME)" 'test.bats'
	}		}
	</~~pre~~>		</syntaxhighlight>

	=== Running the First Tests ===		=== Running the First Tests ===

Admin: Admin moved page Editing Bats - Bash Automated Testing System to Bats - Bash Automated Testing System: Misspelled title: Goofed when copying source from og wiki.

2023-10-07T11:11:23Z

Admin moved page Editing Bats - Bash Automated Testing System to Bats - Bash Automated Testing System: Misspelled title: Goofed when copying source from og wiki.

← Older revision	Revision as of 11:11, 7 October 2023
(No difference)

Admin: Created page with "= Bash Automated Testing System = == Overview == Bats is a [https://testanything.org/ TAP-compliant] testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected. A Bats test file is a Bash script with special syntax for defining test cases. Under the hood, each test case is just a function with a description.

#!/usr/bin/env bats  @test "addition using bc" {   result="$(echo 2+2 | bc)"   [..."

2023-10-04T09:57:10Z

Created page with "= Bash Automated Testing System = == Overview == Bats is a [https://testanything.org/ TAP-compliant] testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected. A Bats test file is a Bash script with special syntax for defining test cases. Under the hood, each test case is just a function with a description. <pre>#!/usr/bin/env bats @test "addition using bc" { result="$(echo 2+2 | bc)" [..."

New page

= Bash Automated Testing System =

== Overview ==

Bats is a [https://testanything.org/ TAP-compliant] testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected.

A Bats test file is a Bash script with special syntax for defining test cases. Under the hood, each test case is just a function with a description.

<pre>#!/usr/bin/env bats

@test "addition using bc" {
result="$(echo 2+2 | bc)"
[ "$result" -eq 4 ]
}</pre>

(The above overview section was stolen verbatim from [https://github.com/sstephenson/bats the main projects README]).

== Install ==

=== Installing Locally ===

The steps below are to install bats at a user level (ie. ~/bin ~/.local/lib). However, Bats can also be installed at a system level (ie. root install, /usr/local) or as a [https://opensource.com/article/19/2/testing-bash-bats submodule of a pre-existing git repository] for CI purposes.

Run the commands below to install bats as well as the bats-assert helper library.

<pre>mkdir $HOME/.local/lib/bats
git clone https://github.com/ztombol/bats-support $HOME/.local/lib/bats/batscore
git clone https://github.com/ztombol/bats-assert $HOME/.local/lib/bats/batsassert
git clone --depth 1 https://github.com/sstephenson/bats $HOME/bats
cd $HOME/bats && ./install.sh $HOME/ && cd .. && rm -rf bats</pre>
== First Tests ==

The examples below are two very simple bats test cases. They test whether or not the script's own file name exists and if the file name is 'test.bats' (two tests it should always pass).

<code>test.bats</code>

<pre>
#!/usr/bin/env bats

setup() {
# Import core and assert modules.
load $HOME/.local/lib/bats/batscore/load.bash
load $HOME/.local/lib/bats/batsassert/load.bash
}

@test "I exist," {
[ -e $BATS_TEST_FILENAME ]
}

@test 'Therefore I am!' {
assert_equal "$(basename $BATS_TEST_FILENAME)" 'test.bats'
}
</pre>

=== Running the First Tests ===

<pre>
./test.bats
✓ I exist!
✓ Therefore I am!

2 tests, 0 failures
</pre>

== Continued Documentation ==

This project is documented pretty well in the following locations. The below docs are also responsible for a lot of the content presented above.

Pick up where this note leaves off by [https://bats-core.readthedocs.io/en/stable/tutorial.html#your-first-test Reading the Docs on Bats].

[https://github.com/sstephenson/bats/blob/master/README.md Main / Original Project README]

[https://github.com/ztombol/bats-assert/blob/master/README.md Bats Assert README]

[https://github.com/ztombol/bats-support/blob/master/README.md Current / Bats Support Project Readme]

Bats - Bash Automated Testing System - Revision history

Admin at 21:39, 28 November 2024

Admin: Admin moved page Editing Bats - Bash Automated Testing System to Bats - Bash Automated Testing System: Misspelled title: Goofed when copying source from og wiki.