Foundation for strictmode by Chemaclass · Pull Request #241 · TypedDevs/bashunit

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

Chemaclass · 2023-12-24T20:50:35Z

📚 Description

Original PR: #239 by @djpohly

Some script authors like to use "unofficial Bash strict mode", enough so that supporting it shows up in comparisons of shell testing frameworks.

Case in point: enabling the -u option uncovered a bug in test_unsuccessful_assert_is_directory_not_writable that is fixed in this PR.

🔖 Changes

The test mentioned above has been fixed ($a_file was supposed to be $a_directory).
Arithmetic expansions ((...)), which exit 1 if their result happens to be zero, are fixed with || true.
The call to check_duplicate_functions does not appear to be intended to cause the script to fail, so it is also silenced with || true.
Optional parameters are given default-empty behavior using e.g. ${1-}.
Optional variables are assigned defaults by evaluating "${varname=default}".

🏗️ Follow up

Add set -euo pipefail to all tests. Currently not possible; needs some more investigation [wip]

✅ To-do list

I updated the CHANGELOG.md to reflect the new feature or fix

A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

Support Bash "strict mode" (and fix one unit test)

Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

for some reason, having this set in all test files make some tests to break, and this needs some investigation. Therefore, to unblock the valid changes and enable merging them asap into main, I will remove that line from everywhere, and we can add it in a follow up PR.

Chemaclass · 2024-07-12T12:52:49Z

Adding set -euo pipefail is not possible yet due to some unknown misbehaviours(🐛 ?)
I will rather work in a follow up PR the fix for it, enabling us to merge the changes of this PR.

For example, ./bashunit tests/acceptance/mock_test.sh without debugging mode (set -x):

And with the debug mode enabled we can already see something, but still is not clear how to fix it:

Maybe @djpohly, @cmayo, @staabm might have some idea on this? 🤔

Follow up issue created: #283

staabm · 2024-07-12T13:07:07Z

no ideas on my end to this - sorry.

djpohlyand others added 5 commits December 21, 2023 16:22

fix behavior under "set -eu"
8c6596d
A few different kinds of changes are made: - Optional parameters/variables are changed to ${var-} to default to empty or given defaults with ${var=...}. - ((...)) arithmetic evaluation "fails" when the result happens to be zero, so silence this with "|| true"

run tests in strictmode
8297ffd
This will help ensure that bashunit won't cause problems with tests that use "set -euo pipefail"

add "strict mode" support to CHANGELOG
ec3b627

Merge pull request#239from djpohly/strictmode
14d2f0e
Support Bash "strict mode" (and fix one unit test)

fix: helper::get_functions_to_run()
6884e4c

Chemaclass added the enhancement New feature or request label Dec 24, 2023

Chemaclass self-assigned this Dec 24, 2023

TypedDevs deleted a comment from watermelon-copilot-for-code-reviewBotDec 25, 2023

antonio-gg-dev force-pushed the strictmode branch from df78662 to e464032Compare March 7, 2024 07:20

Chemaclass force-pushed the main branch from 813f37b to 134a939Compare June 23, 2024 19:25

Merge branch 'main' into strictmode
13c0904
Conflicts: CHANGELOG.md src/console_results.sh src/env_configuration.sh src/runner.sh

Chemaclass force-pushed the strictmode branch from e464032 to 13c0904Compare July 12, 2024 10:58

Chemaclass force-pushed the strictmode branch from 6beb142 to 0cbb089Compare July 12, 2024 12:07

fix: rename acceptance/bastunit.sh add _test suffix
24d4f29

Chemaclass force-pushed the strictmode branch from 3a7d7e0 to 24d4f29Compare July 12, 2024 12:17

Chemaclass changed the title ~~Strictmode~~Foundation for strictmodeJul 12, 2024

Chemaclass marked this pull request as ready for review July 12, 2024 12:32

Chemaclass requested review from JesusValeraDev, antonio-gg-dev, fabriziofs and khru July 12, 2024 12:32

Chemaclass requested a review from cmayo July 12, 2024 12:56

fabriziofs approved these changes Jul 12, 2024
View reviewed changes

docs: update changelog
186d40e

Chemaclass merged commit a2eb9bd into mainJul 12, 2024

Chemaclass deleted the strictmode branch July 12, 2024 13:18

Chemaclass mentioned this pull request Jul 12, 2024
Fix strictmode #285
Merged
1 task