Extend stub_command to functions #92

eviweb · 2016-04-27T09:32:10Z

Hi,

here is a little enhancement that provides a way to stub the shpec assert function.
It is useful to check its behaviour when it is nested in a function body, like in a matcher for example.

Best regards

Eric

it allows to stub the assert function and get an expected result it is useful to test assert result when used in a function body (eq. in a matcher body) Signed-off-by: Eric Villard <[email protected]>

Signed-off-by: Eric Villard <[email protected]>

rylnd · 2016-05-03T15:15:17Z

Perhaps this is more useful as added functionality to stub_command, in cases where the command in question is an existing function that would be lost if we stubbed it. They feel like very similar use cases, and I'd prefer a uniform interface if possible.

While it would still be possible to override shpec functions with this, I struggle to find a reason why you'd want to do so.

Signed-off-by: Eric Villard <[email protected]>

for the second time... :( Signed-off-by: Eric Villard <[email protected]>

Signed-off-by: Eric Villard <[email protected]>

eviweb · 2016-05-03T19:02:17Z

@rylnd, you're right and it's done.
Stubbing shpec assert is interesting when writing a complex matcher calling assert from within its body.
Then it's possible to check the arguments effectively passed to assert and compare the result to what is expected.

best regards

eviweb · 2016-06-23T11:08:35Z

@rylnd,
I've just noticed that the last build of this PR is marked as passed under travis while it should not be.
I will investigate and hope to provide a patch soon.

Eric

rylnd · 2017-04-03T02:18:25Z

@eviweb what is the status of this PR?

eviweb · 2017-04-04T16:00:41Z

hi @rylnd,
still at the same point, I'm sincerely sorry but I'm too busy for now.
Eric

eviweb · 2017-04-04T22:24:28Z

@rylnd,
I don't find any way to retrieve the function definition under Dash.
The type command does not provide the same information under Dash as it does under the other supported shells.
Do you have any idea on how to fix this ?

rylnd

@eviweb thanks again for your work; sorry for taking so long to get back to this.

rylnd · 2017-04-25T14:10:43Z

bin/shpec

@@ -36,11 +36,30 @@ end_describe() {
 # any identifier as a function name.

 stub_command() {
+  local func_decl="$(get_function_declaration "$1")"
+  [ -n "${func_decl}" ] && eval "_shpec____${func_decl}"


do we ever unset this internal definition?

Local vars do not need to be unset as they are local but KSH does not support the local keyword, I corrected that in another pending branch...

I'm not referring to func_decl, I'm referring to the function that is evald here. After calling stub_command foo; unstub_command foo there will be still be a _shpec___foo function in the namespace, correct?

rylnd · 2017-04-25T14:10:47Z

bin/shpec

+get_function_declaration()
+{
+  if [ "${SHELL}" = "dash" ]; then
+    type "$1" | tail -n +2


I might be misunderstanding this: I thought that everything except for dash can use type; this seems to indicate the opposite.

Given the discussion in #89, dash's own docs, and our previous conversation, I'm fine keeping use of the (non-POSIX) type and typeset commands. If this becomes a problem, we can revisit (or move this feature to a plugin).

That's what I explained in my last comment #92 (comment), Unfortunately there's currently no way I see to retrieve the body of a function under Dash 😞

rylnd · 2017-04-25T14:10:53Z

shpec/shpec_shpec.sh

@@ -86,6 +86,15 @@ line'
      assert equal "$(curl)" "stubbed body"
      unstub_command "curl"
    end
+
+    it "prevents loosing stubbed function"


s/loosing/losing please!

It will be done if we can find a solution for the problem mentioned here #92 (comment)

eviweb · 2017-04-26T17:26:57Z

@rylnd,
in fact the title of this PR does no more represent really what it now tries to address.
I started to provide a way to stub the assert function, but I noticed that stubbed functions (not commands) are lost after having been unstubbed.
Putting aside the issue of the type command under Dash, I should be able to solve this problem under the other supported shells.
Maybe should it effectively be done as a plugin as suggested, instead of being part of the core for now.
What do you think about this?
In that case, do you want to integrate plugins in this repo?
Should plugins be considered as custom matchers or do you plan to provide a new entrypoint for plugins as you have done for custom matchers? Or is there another preferable way to go?
Best
Eric

rylnd · 2017-04-26T19:42:49Z

@eviweb my mistake; I thought I had seen typeset work under dash, but I was mistaken.

@hlangeveld you had done some research for #89 into how to obtain a command's type with various POSIX(ish) builtins; are you aware of any way to obtain the function declaration in dash?

If not, then we either drop dash support or we move this work to a plugin. I will give #108 some thought; I would love to hear others' thoughts/ideas there as well.

eviweb added 2 commits April 27, 2016 11:08

add shpec assert function stub utility

98c14c3

it allows to stub the assert function and get an expected result it is useful to test assert result when used in a function body (eq. in a matcher body) Signed-off-by: Eric Villard <[email protected]>

fix string replacement for sh and dash using sed

7a0d254

Signed-off-by: Eric Villard <[email protected]>

eviweb added 3 commits May 3, 2016 20:38

move backup of existing funcs to [un]stub_command

ce77361

Signed-off-by: Eric Villard <[email protected]>

fix string replacement for sh

8ce6275

for the second time... :( Signed-off-by: Eric Villard <[email protected]>

remove extra double quotes due to IDE autocomplete

b831754

Signed-off-by: Eric Villard <[email protected]>

rylnd requested changes Apr 25, 2017

View reviewed changes

rylnd changed the title ~~Stub assert~~ Extend stub_command to functions Apr 27, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend stub_command to functions #92

Extend stub_command to functions #92

eviweb commented Apr 27, 2016

rylnd commented May 3, 2016

eviweb commented May 3, 2016

eviweb commented Jun 23, 2016

rylnd commented Apr 3, 2017

eviweb commented Apr 4, 2017

eviweb commented Apr 4, 2017

rylnd left a comment

rylnd Apr 25, 2017

eviweb Apr 26, 2017

rylnd Apr 26, 2017

rylnd Apr 25, 2017

rylnd Apr 25, 2017

eviweb Apr 26, 2017

rylnd Apr 25, 2017

eviweb Apr 26, 2017

eviweb commented Apr 26, 2017

rylnd commented Apr 26, 2017

Extend stub_command to functions #92

Are you sure you want to change the base?

Extend stub_command to functions #92

Conversation

eviweb commented Apr 27, 2016

rylnd commented May 3, 2016

eviweb commented May 3, 2016

eviweb commented Jun 23, 2016

rylnd commented Apr 3, 2017

eviweb commented Apr 4, 2017

eviweb commented Apr 4, 2017

rylnd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eviweb commented Apr 26, 2017

rylnd commented Apr 26, 2017