chore: get_provider_data @?data_provider

Author: Chemaclass

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Fix asserts on test doubles in subshell
 - Allow interpolating arguments in data providers output
+- Deprecate `# data_provider` in favor of `# @data_provider`
 
 ## [0.19.1](https://github.com/TypedDevs/bashunit/compare/0.19.0...0.19.1) - 2025-05-23
 

src/helpers.sh

@@ -159,8 +159,8 @@ function helper::get_provider_data() {
 
   data_provider_function=$(\
     grep -B 1 "function $function_name()" "$script" |\
-    grep "# data_provider " |\
-    sed -E -e 's/\ *# data_provider (.*)$/\1/g'\
+    grep -E "# *@?data_provider " |\
+    sed -E -e 's/\ *# *@?data_provider (.*)$/\1/g'\
     || true
   )
 

tests/functional/provider_test.sh

@@ -5,7 +5,7 @@ function set_up() {
   _GLOBAL="aa-bb"
 }
 
-# data_provider provide_multiples_values
+# @data_provider provide_multiples_values
 function test_multiple_values_from_data_provider() {
   local first=$1
   local second=$2
@@ -17,7 +17,7 @@ function provide_multiples_values() {
   echo "aa" "bb"
 }
 
-# data_provider provide_single_values
+# @data_provider provide_single_values
 function test_single_values_from_data_provider() {
   local data="$1"
 
@@ -30,7 +30,7 @@ function provide_single_values() {
   echo "three"
 }
 
-# data_provider provide_single_value
+# @data_provider provide_single_value
 function test_single_value_from_data_provider() {
   local current_data="$1"
 

tests/unit/assert_test.sh

@@ -11,7 +11,7 @@ function test_unsuccessful_fail() {
     "$(fail "Failure message")"
 }
 
-# data_provider provider_successful_assert_true
+# @data_provider provider_successful_assert_true
 function test_successful_assert_true() {
   # shellcheck disable=SC2086
   assert_empty "$(assert_true $1)"
@@ -45,7 +45,7 @@ function test_unsuccessful_assert_true_on_function() {
     "$(assert_true "eval return 2")"
 }
 
-# data_provider provider_successful_assert_false
+# @data_provider provider_successful_assert_false
 function test_successful_assert_false() {
   # shellcheck disable=SC2086
   assert_empty "$(assert_false $1)"

tests/unit/check_os_test.sh

@@ -40,7 +40,7 @@ function test_detect_osx_os() {
   assert_equals "OSX" "$_OS"
 }
 
-# data_provider window_linux_variations
+# @data_provider window_linux_variations
 function test_detect_windows_os() {
   local windows_linux="$1"
   mock uname echo "$windows_linux"

tests/unit/helpers_test.sh

@@ -123,7 +123,7 @@ function fake_provider_data_string() {
 
 function test_get_provider_data() {
   # shellcheck disable=SC2317
-  # data_provider fake_provider_data_string
+  # @data_provider fake_provider_data_string
   function fake_function_get_provider_data() {
     return 0
   }
@@ -138,7 +138,7 @@ function fake_provider_data_array() {
 
 function test_get_provider_data_array() {
   # shellcheck disable=SC2317
-  # data_provider fake_provider_data_array
+  # @data_provider fake_provider_data_array
   function fake_function_get_provider_data_array() {
     return 0
   }
@@ -150,7 +150,7 @@ function test_get_provider_data_array() {
 
 function test_get_provider_data_should_returns_empty_when_not_exists_provider_function() {
   # shellcheck disable=SC2317
-  # data_provider not_existing_provider
+  # @data_provider not_existing_provider
   function fake_function_get_not_existing_provider_data() {
     return 0
   }