Skip to content

Commit b9ef6db

Browse files
committed
Updated the README.md and added images
1 parent f98c244 commit b9ef6db

File tree

5 files changed

+26
-5
lines changed

5 files changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,29 @@
33
## Learning Objectives
44
- Use arrays to store collections of data
55

6-
Set up instructions
7-
Fork this repository and clone the forked version to your machine
8-
Open the solution
9-
Implement the requirements listed in Core.cs
10-
When ready to test your solution, open the Test Explorer to run tests.
6+
## Set up instructions
7+
- Fork this repository and clone the forked version to your machine
8+
- Open the csharp-fundamentals-arrays.sln solution
9+
- Implement the requirements listed in Core.cs
10+
- When ready to test your solution, open the Test Explorer to run tests.
11+
12+
![](./assets/run_tests.png)
13+
14+
- If you need to run a single test
15+
![](./assets/run_test_single.png)
16+
17+
## Test Output
18+
19+
When you run a test, it's either going to pass or fail. When it fails, you'll be presented with a big red X next to the test. It is very important to learn to recognize those errors and be able to debug them.
20+
21+
We can see in the screenshot below that we are failing all of the tests. To check why a test is failing I can click the test that interests me and then at the bottom left we can see that I have a message and a Stack Trace.
22+
23+
The stack trace details in which classes & files the failure happened, and gives you a line number at the end. Most of the lines in the stack trace are irrelevant most of the time, you want to try and identify the files that you're actually working with.
24+
25+
In the sample screenshot below, we've tried to complete the first step of the exercise but provided an invalid value. Then we run the test associated with it and we see a big red stack trace, a test failure.
26+
27+
At the top, we see `expected: 512 but was: 0`. This means the test expected the value to be 512, but the value the student provided was 0.
28+
29+
In the stack trace itself, we see this line: `1. at csharp_fundamentals_primitive_types.Test.CoreTests.twoShouldBe512() in C:\Dev\boolean\csharp\fundamentals\csharp-fundamentals-primitive-types\src\csharp-fundamentals-primitive-types.Test\CoreTests.cs:line 17`. This is helpful! This tells us the exact line in the `CoreTests.cs` file (line 17) where the failure happened, as well as the method name (twoShouldBe512), helping us to identify where the issue began. This is the kind of thing you need to look for; a relevant file name, method name, class name and line number to give you a good starting point for debugging.
30+
31+
![](./assets/test-failure.png)

assets/open_core_code.png

17.7 KB
Loading

assets/run_test_single.png

31.3 KB
Loading

assets/run_tests.png

49.9 KB
Loading

assets/test-failure.png

36.4 KB
Loading

0 commit comments

Comments
 (0)