Programming/Bash/Unit Testing - Revision history

Brodriguez: Update page for proper syntax from non-depreciated Bats project

2020-10-25T23:05:09Z

Update page for proper syntax from non-depreciated Bats project

@@ Line 1: / Line 1: @@
 For UnitTesting in bash, use [https://github.com/bats-core/bats-core Bats].
-Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules|Git Submodule]].
+Bats is a Bash UnitTesting framework, that's installed into the system PATH via [[NPM]].
-== Installing Bats Within a Project ==
+== Installing Bats ==
-Effectively, first add the submodule:
+With [[NPM]] installed, run:
-  git submodule add https://github.com/sstephenson/bats tests/libs/bats
+  sudo npm install -g bats
- git submodule add https://github.com/ztombol/bats-assert tests/libs/bats-assert
- git submodule add https://github.com/ztombol/bats-support tests/libs/bats-support
+See https://github.com/bats-core/bats-core for alternative install methods.
 == Using Bats ==
 From what I've seen, documentation on the web is inconsistent in regards to calling bats, so I document here what I found to work best for me:
@@ Line 33: / Line 29: @@
-) At this point, create one or more separate test files, group related tests together.
+) At this point, create one or more separate test files, group related tests together. Call these subfiles them from your main {{ ic |tests.sh}} file via the command:
+  bats <test_file_to_call>
@@ Line 48: / Line 39: @@
 == Functions ==
 To initialize functions that run at the start and end of every test with:
   ###
@@ Line 71: / Line 77: @@
-== Assertion Statements ==
+== Assertions ==
-Import assertion functions with:
+Assertions are done via standard if statement syntax. Simply include the condition clause but nothing else.
 Ex:
@@ Line 124: / Line 91: @@
 If any of these checks were to fail, then the test itself would stop on the given line and return a failure.

Brodriguez: Add reference to source repo

2020-10-25T22:36:45Z

Add reference to source repo

← Older revision		Revision as of 22:36, 25 October 2020
Line 1:		Line 1:
	For UnitTesting in bash, use ~~'''~~Bats~~'''~~.		For UnitTesting in bash, use [https://github.com/bats-core/bats-core Bats].

	Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].		Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].

Brodriguez: Correct some assertion lines

2020-10-25T21:46:36Z

Correct some assertion lines

← Older revision		Revision as of 21:46, 25 October 2020
Line 88:		Line 88:

	# Assert function succeeds (returns 0).		# Assert function succeeds (returns 0).
	~~assert_success~~ <function_call>		run <function_call>
			assert_success

	# Assert function fails (returns 1).		# Assert function fails (returns non-0).
	~~assert_failure~~ <function_call>		run <function_call>
			assert_failure

	# Assert that a variable called '''${output}''' matches the expected value.		# Assert that a variable called '''${output}''' matches the expected value.
			run <function_call>
	assert_output <expected_value>		assert_output <expected_value>

	# Assert that a variable called '''${output}''' does not match the expected value.		# Assert that a variable called '''${output}''' does not match the expected value.
			run <function_call>
	refute_output <expected_value>		refute_output <expected_value>

Brodriguez: Update formatting

2020-10-25T21:24:43Z

Update formatting

← Older revision		Revision as of 21:24, 25 October 2020
Line 2:		Line 2:

	Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].		Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].

	~~Note that to prevent variable state leak between tests, each test is executed as a separate process. Thus, any echo statements within the tests themselves will not visually print out to console.~~


Line 69:		Line 67:
	# Test logic here.		# Test logic here.
	}		}

			{{ note \| To prevent variable state leak between tests, each test is executed as a separate process. Thus, any echo statements within the tests themselves will not visually print out to console.}}

Brodriguez: Add further notes

2020-10-25T21:23:47Z

Add further notes

← Older revision		Revision as of 21:23, 25 October 2020
Line 2:		Line 2:

	Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].		Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].

			Note that to prevent variable state leak between tests, each test is executed as a separate process. Thus, any echo statements within the tests themselves will not visually print out to console.


Line 43:		Line 45:

	If done correctly, all tests in that file should execute. Repeat for every test file you wish to run.		If done correctly, all tests in that file should execute. Repeat for every test file you wish to run.

			For added clarification, add echo statements between file imports, in order to visually split up test output.

Brodriguez: Document actually getting bats to run

2020-10-25T21:16:04Z

Document actually getting bats to run

@@ Line 10: / Line 10: @@
   git submodule add https://github.com/ztombol/bats-support tests/libs/bats-support
   git commit
 == Functions ==
-Can initialize functions that run at the start and end of every test with:
+To initialize functions that run at the start and end of every test with:
   ###
    # This will run at the start of every test.
@@ Line 36: / Line 68: @@
 == Assertion Statements ==
-As of writing this, possible assertion statements appear to be:
+Import assertion functions with:
   # Assert success.
   assert <command>

Brodriguez: Update content for post-import

2020-10-25T21:00:57Z

Update content for post-import

← Older revision		Revision as of 21:00, 25 October 2020
Line 1:		Line 1:
	~~The~~ UnitTesting ~~I've found~~ in ~~Bash is to~~ use '''Bats'''~~. Full description found at https://opensource.com/article/19/2/testing-bash-bats~~.		For UnitTesting in bash, use '''Bats'''.

	~~Effectively~~, ~~first add~~ [[Programming/Git Submodules\|Git ~~Submodules~~]]:		Bats is a Bash UnitTesting framework, that's imported as a [[Programming/Git Submodules\|Git Submodule]].


			== Installing Bats Within a Project ==
			Effectively, first add the submodule:
	git submodule add https://github.com/sstephenson/bats tests/libs/bats		git submodule add https://github.com/sstephenson/bats tests/libs/bats
	git submodule add https://github.com/ztombol/bats-assert tests/libs/bats-assert		git submodule add https://github.com/ztombol/bats-assert tests/libs/bats-assert
Line 8:		Line 12:


	=== Functions ===		== Functions ==
	Can initialize functions that run at the start and end of every test with:		Can initialize functions that run at the start and end of every test with:

Line 30:		Line 34:
	}		}

	=== Assertion Statements ===
			== Assertion Statements ==
	As of writing this, possible assertion statements appear to be:		As of writing this, possible assertion statements appear to be:
	# Assert success.		# Assert success.
Line 59:		Line 64:
	refute_line <line_to_match>		refute_line <line_to_match>

	=== Other Assertions ===
			== Other Assertions ==
	It's possible to also do assertions via standard if statement syntax. Simply include the condition clause but nothing else.		It's possible to also do assertions via standard if statement syntax. Simply include the condition clause but nothing else.

Brodriguez: Import contents from bash page

2020-10-25T20:58:09Z

Import contents from bash page

New page

The UnitTesting I've found in Bash is to use '''Bats'''. Full description found at https://opensource.com/article/19/2/testing-bash-bats.

Effectively, first add [[Programming/Git Submodules|Git Submodules]]:
git submodule add https://github.com/sstephenson/bats tests/libs/bats
git submodule add https://github.com/ztombol/bats-assert tests/libs/bats-assert
git submodule add https://github.com/ztombol/bats-support tests/libs/bats-support
git commit

=== Functions ===
Can initialize functions that run at the start and end of every test with:

###
# This will run at the start of every test.
##
setup () {
# Setup logic here.
}

###
# This will run at the end of every test.
##
teardown () {
# Teardown logic here.
}

Create actual tests with:
@test "<name_of_test>" {
# Test logic here.
}

=== Assertion Statements ===
As of writing this, possible assertion statements appear to be:
# Assert success.
assert <command>

# Assert failure.
refute <command>

# Assert two values are equal.
assert_equal <val_1> <val_2>

# Assert function succeeds (returns 0).
assert_success <function_call>

# Assert function fails (returns 1).
assert_failure <function_call>

# Assert that a variable called '''${output}''' matches the expected value.
assert_output <expected_value>

# Assert that a variable called '''${output}''' does not match the expected value.
refute_output <expected_value>

# Assert that a given line appears in "output". {{ Todo | is this a variable? Or actual echo output? }}
assert_line <line_to_match>

# Assert that a given line does not appear in "output". {{ Todo | is this a variable? Or actual echo output? }}
refute_line <line_to_match>

=== Other Assertions ===
It's possible to also do assertions via standard if statement syntax. Simply include the condition clause but nothing else.

Ex:
# Check if '''${my_var}''' is equal to 5.
[[ ${my_var} == 5 ]]

# Check if '''${my_var}''' does not match the string "This is a string."
[[ ${my_var} != "This is a string." ]]

# Check if '''${some_number}''' is greater than 5.
[[ ${some_number} > 5 ]]

If any of these checks were to fail, then the test itself would stop on the given line and return a failure.