[Console] Adapt doc for easier testing of commands needing user inputs #6623

chalasr · 2016-05-28T07:50:33Z

This one eases testing of commands needing user interactions by simulating them from the CommandTester directly, by creating a input stream from the ones set by the developer.

xabbuh · 2016-05-29T17:43:17Z

components/console/helpers/questionhelper.rst

-If you want to write a unit test for a command which expects some kind of input
-from the command line, you need to set the helper input stream::
+If you want to write a unit test for a command which expects user inputs
+from the command line, you need to set the inputs like this:


You need to end the paragraph with two colons so that the following block will be properly treated as a PHP code block.

Fixed, Thank's @xabbuh

OskarStark · 2016-06-02T06:26:04Z

LGTM 👍

chalasr · 2016-06-02T08:28:03Z

Updated according to symfony/symfony@19117ce
Tests pass

@javiereguiluz

…dTester (chalasr) This PR was merged into the 3.2-dev branch. Discussion ---------- [Console] Simplify simulation of user inputs in CommandTester | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#6623 After @javiereguiluz pointed it in #17470, I open this PR to simplify the simulation of user inputs for testing a Command. It would be done by calling `CommandTester::setUserInputs()` with an array of inputs as argument, and so make the CommandTester creating an input stream from the inputs set by the developer, then call `QuestionHelper::setInputStream` and assign it to the helperSet of the command, sort as all is done automatically in one call. Depends on #18999 Commits ------- c7ba38a [Console] Set user inputs from CommandTester

@javiereguiluz

…dTester (chalasr) This PR was merged into the 3.2-dev branch. Discussion ---------- [Console] Simplify simulation of user inputs in CommandTester | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#6623 After @javiereguiluz pointed it in #17470, I open this PR to simplify the simulation of user inputs for testing a Command. It would be done by calling `CommandTester::setUserInputs()` with an array of inputs as argument, and so make the CommandTester creating an input stream from the inputs set by the developer, then call `QuestionHelper::setInputStream` and assign it to the helperSet of the command, sort as all is done automatically in one call. Depends on #18999 Commits ------- c7ba38a [Console] Set user inputs from CommandTester

chalasr · 2016-06-16T15:24:06Z

This is no more on hold, the PR has been merged.

javiereguiluz · 2016-06-16T15:37:24Z

Status: needs review

chalasr · 2016-06-16T15:39:01Z

Thank you @javiereguiluz, can I do it myself for next?

javiereguiluz · 2016-06-16T15:48:49Z

@chalasr yes, it's explained a bit here: http://symfony.com/doc/current/contributing/community/reviews.html#the-bug-report-review-process

Sadly our bot still has things to learn. I'd love to say: "hey Carson, remove the "On hold" label"

xabbuh · 2016-06-18T06:31:06Z

components/console/helpers/questionhelper.rst

-input stream.
+By calling :method:`CommandTester::setInputs`, you imitate what the console would
+do internally with all user input through the CLI. This way you can test any
+user interaction (even complex ones) by passing the appropriate inputs.


I think we should be more explicit what it means that the input is an array (IIUC one element is read once new input is requested by the command, right?).

@xabbuh right, the behavior stays the same, we create a string from the given array of inputs, (each input is separated via a "\n"), then the QuestionHelper reads the stream when ask() is called (via fgets).
I added a short explanation, I hope it is clear enough.

wouterj · 2016-06-19T09:36:09Z

components/console/helpers/questionhelper.rst

-console would do internally with all user input through the CLI. This way
-you can test any user interaction (even complex ones) by passing an appropriate
-input stream.
+By calling :method:`CommandTester::setInputs`, you imitate what the console would


this needs to be the FQCN

wouterj · 2016-06-19T09:38:11Z

Thanks for the contribution @chalasr! I've added 2 not so big comments.

Status: needs work

chalasr · 2016-06-19T10:57:08Z

@wouterj I made the changes.

Status: needs review

chalasr · 2016-06-20T19:24:13Z

I made some changes.
Do not hesitate to give me your suggestions, writing documentation is almost harder than adding the feature itself!

Status: needs review

wouterj · 2016-06-21T10:23:14Z

components/console/helpers/questionhelper.rst

        // Equals to a user inputting "Test" and hitting ENTER
-        // If you need to enter a confirmation, "yes\n" will work
+
+        $commandTester->setInputs('This', 'That');


should be array('This', 'That') (same on line 299).

Also, I think we should add the descriptive comment before the line of code.

chalasr · 2016-06-22T12:28:18Z

@wouterj Changes made, thanks for the review.

wouterj · 2016-06-22T12:46:01Z

Status: reviewed

👍 thanks for the contribution!

chalasr · 2016-06-23T18:32:55Z

@javiereguiluz Please let me know if it is complete enough for you.

Fix missing colon Change userInputs to inputs Try to fix platformsh build Re-add useful use statements Fixed typo, use FQCN::method Rollback not useful diff Formatting Add more examples, precise documentation typo 'would have type' => 'would have typed' removing an ending dot in comment for consistency

javiereguiluz · 2016-06-23T19:16:10Z

👍

@chalasr thanks for providing these docs and for your patience during the review process.

xabbuh · 2016-06-30T16:58:25Z

Thank you @chalasr.

…ing user inputs (chalasr) This PR was merged into the master branch. Discussion ---------- [Console] Adapt doc for easier testing of commands needing user inputs Doc-PR for symfony/symfony#18710. This one eases testing of commands needing user interactions by simulating them from the CommandTester directly, by creating a input stream from the ones set by the developer. Commits ------- 26fdbe0 [Console] Adapt doc for easier testing of commands needing user inputs

chalasr mentioned this pull request May 28, 2016

[Console] Simplify simulation of user inputs in CommandTester symfony/symfony#18710

Merged

wouterj added the On hold label May 28, 2016

xabbuh reviewed May 29, 2016
View reviewed changes

chalasr force-pushed the commandtester_userinputs branch from 8af5ff0 to 0d03e8a Compare June 4, 2016 10:43

chalasr force-pushed the commandtester_userinputs branch from 0d03e8a to a8e793a Compare June 16, 2016 11:00

carsonbot added the Status: Needs Review label Jun 16, 2016

chalasr force-pushed the commandtester_userinputs branch from a8e793a to 096308f Compare June 16, 2016 17:39

xabbuh removed the On hold label Jun 18, 2016

xabbuh reviewed Jun 18, 2016
View reviewed changes

chalasr force-pushed the commandtester_userinputs branch from 51eb9d0 to b50ab55 Compare June 18, 2016 10:34

wouterj reviewed Jun 19, 2016
View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 19, 2016

chalasr force-pushed the commandtester_userinputs branch 5 times, most recently from bc90258 to b56ad94 Compare June 19, 2016 10:52

carsonbot removed the Status: Needs Work label Jun 19, 2016

carsonbot added the Status: Needs Work label Jun 20, 2016

chalasr force-pushed the commandtester_userinputs branch 4 times, most recently from f2bcdfc to e9218b3 Compare June 20, 2016 19:14

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 20, 2016

wouterj reviewed Jun 21, 2016
View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jun 22, 2016

chalasr force-pushed the commandtester_userinputs branch 3 times, most recently from fa056e2 to eaa3294 Compare June 23, 2016 18:28

chalasr force-pushed the commandtester_userinputs branch from eaa3294 to 0694d58 Compare June 23, 2016 18:34

chalasr force-pushed the commandtester_userinputs branch from 0694d58 to 26fdbe0 Compare June 23, 2016 18:46

xabbuh merged commit 26fdbe0 into symfony:master Jun 30, 2016

xabbuh added a commit that referenced this pull request Jun 30, 2016

[#6623] fix note directive

6e4b3a0

chalasr deleted the commandtester_userinputs branch June 30, 2016 17:02

chalasr restored the commandtester_userinputs branch August 16, 2016 12:02

javiereguiluz mentioned this pull request Oct 12, 2016

Testing a Command that Expects Input #5246

Closed

chalasr deleted the commandtester_userinputs branch October 25, 2016 19:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Adapt doc for easier testing of commands needing user inputs #6623

[Console] Adapt doc for easier testing of commands needing user inputs #6623

chalasr commented May 28, 2016 •

edited

Loading

xabbuh May 29, 2016

chalasr May 29, 2016

OskarStark commented Jun 2, 2016

chalasr commented Jun 2, 2016 •

edited

Loading

chalasr commented Jun 16, 2016

javiereguiluz commented Jun 16, 2016

chalasr commented Jun 16, 2016

javiereguiluz commented Jun 16, 2016

xabbuh Jun 18, 2016

chalasr Jun 18, 2016 •

edited

Loading

wouterj Jun 19, 2016

wouterj commented Jun 19, 2016

chalasr commented Jun 19, 2016

chalasr commented Jun 20, 2016

wouterj Jun 21, 2016

chalasr commented Jun 22, 2016

wouterj commented Jun 22, 2016

chalasr commented Jun 23, 2016

javiereguiluz commented Jun 23, 2016

xabbuh commented Jun 30, 2016

[Console] Adapt doc for easier testing of commands needing user inputs #6623

[Console] Adapt doc for easier testing of commands needing user inputs #6623

Conversation

chalasr commented May 28, 2016 • edited Loading

xabbuh May 29, 2016

Choose a reason for hiding this comment

chalasr May 29, 2016

Choose a reason for hiding this comment

OskarStark commented Jun 2, 2016

chalasr commented Jun 2, 2016 • edited Loading

chalasr commented Jun 16, 2016

javiereguiluz commented Jun 16, 2016

chalasr commented Jun 16, 2016

javiereguiluz commented Jun 16, 2016

xabbuh Jun 18, 2016

Choose a reason for hiding this comment

chalasr Jun 18, 2016 • edited Loading

Choose a reason for hiding this comment

wouterj Jun 19, 2016

Choose a reason for hiding this comment

wouterj commented Jun 19, 2016

chalasr commented Jun 19, 2016

chalasr commented Jun 20, 2016

wouterj Jun 21, 2016

Choose a reason for hiding this comment

chalasr commented Jun 22, 2016

wouterj commented Jun 22, 2016

chalasr commented Jun 23, 2016

javiereguiluz commented Jun 23, 2016

xabbuh commented Jun 30, 2016

chalasr commented May 28, 2016 •

edited

Loading

chalasr commented Jun 2, 2016 •

edited

Loading

chalasr Jun 18, 2016 •

edited

Loading