Update unit test tutorials #1726

guardrex · 2017-03-14T07:44:14Z

Reorganizes the setup to reflect the steps needed to establish the project folder
Calls out either walking thru the tutorial building the samples or taking them down from GH (Note that exactly how that will be done/instructed is WIP: Need: Instructions on how to download samples #1644)
Grammar/style overhaul
Samples updated for 1.1 and latest stable packages

dnfclas · 2017-03-14T07:44:18Z

@guardrex,
Thanks for having already signed the Contribution License Agreement. Your agreement was validated by .NET Foundation. We will now review your pull request.
Thanks,
.NET Foundation Pull Request Bot

guardrex · 2017-03-14T22:42:07Z

I'm going to dogfood the commands just to make absolutely sure they comport with the sample code.

mairaw

Thanks @guardrex. I think overall it looks great. I've left a few comments.

mairaw · 2017-03-14T22:42:02Z

docs/core/testing/unit-testing-with-dotnet-test.md


-[View or download sample code](https://github.com/dotnet/docs/tree/master/samples/core/getting-started/unit-testing-using-dotnet-test)
+[Writing Libraries with Cross Platform Tools](../tutorials/libraries.md) has information on organizing multi-project solutions for both the source and the tests. This tutorial follows those conventions. This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/docs/tree/master/samples/core/getting-started/unit-testing-using-dotnet-test/) before you begin.


I'd remove or move the first two sentences especially because that topic is now outdated. Also, it seems odd to open the topic with that. Also, I kind of liked having the final structure shown early.

mairaw · 2017-03-14T22:43:27Z

docs/core/testing/unit-testing-with-dotnet-test.md


-By [Steve Smith](http://ardalis.com) and [Bill Wagner](https://github.com/BillWagner)
+## Creating the projects


no need for a section here.

mairaw · 2017-03-14T22:47:20Z

docs/core/testing/unit-testing-with-dotnet-test.md

-has information on organizing multi-project solutions for both the
-source and the tests. This article follows those conventions. The
-final project structure will be something like this:
+Open a shell window. Create a directory to hold the solution, *unit-testing-using-dotnet-test*. Start in the *unit-testing-using-dotnet-test* directory and create a *PrimeService* directory. The directory structure thus far is shown below:


Suggestion for flow: Create a directory called unit-testing-using-dotnet-test to hold the solution. Inside this new directory, create a PrimeService directory.

mairaw · 2017-03-14T22:50:20Z

docs/core/testing/unit-testing-with-dotnet-test.md

-`dotnet new` added xUnit, and the xUnit runner. You need to add the PrimeService
-package as another dependency to the project. You can do that using the `dotnet`
-CLI:
+The test project requires other packages to create and run unit tests. `dotnet new` in the previous step added xUnit and the xUnit runner. Now, add the `PrimeService` class library as another dependency to the project. Use the `dotnet` CLI:


Use the dotnet CLI -> You can do that using the dotnet add reference command. (you can link to the command too)

mairaw · 2017-03-14T22:53:07Z

docs/core/testing/unit-testing-with-dotnet-test.md

-then repeating the process. So, let's write that one failing test. Remove
-`UnitTest1.cs` from the `PrimeService.Tests` directory, and create a new
-C# file named `PrimeService_IsPrimeShould.cs` with the following content:
+The TDD approach calls for writing one failing test, making it pass, then repeating the process. Now, write one failing test: Remove *UnitTest1.cs* from the *PrimeService.Tests* directory and create a new C# file named *PrimeService_IsPrimeShould.cs* with the following content:


Now, write one failing test -> the old sentence looked better here

So, let's write that one failing test.

The conjunction and 1st person are problems. I can remove the whole sentence ... it isn't really needed.

Let's just remove it. It's fluff.

mairaw · 2017-03-14T22:55:10Z

docs/core/testing/unit-testing-with-dotnet-test.md

@@ -142,68 +114,37 @@ namespace Prime.UnitTests.Services
 }
 ```

-The `[Fact]` attribute denotes a method as a single test. 
+The `[Fact]` attribute denotes a method as a single test. Execute `dotnet test` to build the tests and the class library and then run the tests. The xUnit test runner contains the program entry point to run your tests. `dotnet test` starts the test runner and provides a command-line argument to the test runner indicating the assembly that contains your tests.


I kind of like to link to the commands page when we mention them but it's not a requirement

mairaw · 2017-03-14T23:24:10Z

samples/core/getting-started/unit-testing-using-dotnet-test/README.md


-The example provides a service that indicates whether a number is prime.
+## Restore and test


you can run just the app too, no?

It's not runnable ... class lib. AFAIK one has to run the test command. That's the way the original author had it. They had you restoring the lib and running build, but those steps aren't necessary. All they have to do is dotnet restore and dotnet test in the tests project. It restores both, builds both, and runs the tests.

oh yeah, never mind... duh

How do you think I feel? ..... On the first pass, I gave the darn blasted thing an entry point! lol

mairaw

Looks great! I have a small question that would apply to both. @BillWagner do you wanna take a look at this?

mairaw · 2017-03-16T16:31:19Z

docs/core/testing/unit-testing-with-dotnet-test.md


-The generated template configured the test runner
-in the PrimeServiceTests.csproj:
+```


should we show this after you do the dotnet new xunit so you have the full project structure somewhere?

Easy enough to add ... do you want me to pop it in there?

BillWagner · 2017-03-20T22:13:09Z

LGTM. I'll

Initial commit

312af6a

guardrex added enhancement labels Mar 14, 2017

guardrex added this to the March 2017 milestone Mar 14, 2017

guardrex self-assigned this Mar 14, 2017

dnfclas added the cla-already-signed label Mar 14, 2017

Luke Latham and others added 3 commits March 14, 2017 14:18

Update README files and sample code

b25fded

Merge branch 'master' into guardrex/unit-testing-tutorials-update

8cfe23a

Updates

6c29f68

guardrex removed the WIP label Mar 14, 2017

guardrex changed the title ~~[WIP] Update unit test tutorials~~ Update unit test tutorials Mar 14, 2017

guardrex added the WIP label Mar 14, 2017

Sample update

bece630

mairaw reviewed Mar 14, 2017

View reviewed changes

React to feedback

286c6bc

mairaw approved these changes Mar 16, 2017

View reviewed changes

React to feedback

51ed5fa

guardrex removed the WIP label Mar 17, 2017

BillWagner merged commit ff14358 into dotnet:master Mar 20, 2017

guardrex deleted the guardrex/unit-testing-tutorials-update branch March 20, 2017 22:13

guardrex removed this from the March 2017 milestone Mar 29, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update unit test tutorials #1726

Update unit test tutorials #1726

guardrex commented Mar 14, 2017

dnfclas commented Mar 14, 2017

guardrex commented Mar 14, 2017

mairaw left a comment

mairaw Mar 14, 2017

mairaw Mar 14, 2017

mairaw Mar 14, 2017

mairaw Mar 14, 2017

mairaw Mar 14, 2017

guardrex Mar 15, 2017

guardrex Mar 15, 2017

mairaw Mar 14, 2017

mairaw Mar 14, 2017

guardrex Mar 15, 2017

mairaw Mar 15, 2017

guardrex Mar 15, 2017

mairaw left a comment

mairaw Mar 16, 2017

guardrex Mar 16, 2017

guardrex Mar 17, 2017

BillWagner commented Mar 20, 2017


		[View or download sample code](https://github.com/dotnet/docs/tree/master/samples/core/getting-started/unit-testing-using-dotnet-test)
		[Writing Libraries with Cross Platform Tools](../tutorials/libraries.md) has information on organizing multi-project solutions for both the source and the tests. This tutorial follows those conventions. This tutorial takes you through an interactive experience building a sample solution step-by-step to learn unit testing concepts. If you prefer to follow the tutorial using a pre-built solution, [view or download the sample code](https://github.com/dotnet/docs/tree/master/samples/core/getting-started/unit-testing-using-dotnet-test/) before you begin.


		By [Steve Smith](http://ardalis.com) and [Bill Wagner](https://github.com/BillWagner)
		## Creating the projects


		The example provides a service that indicates whether a number is prime.
		## Restore and test

Update unit test tutorials #1726

Update unit test tutorials #1726

Conversation

guardrex commented Mar 14, 2017

dnfclas commented Mar 14, 2017

guardrex commented Mar 14, 2017

mairaw 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

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

mairaw 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

BillWagner commented Mar 20, 2017