add script.fsx info. to TC-Breakdown page.

master
Craig Oates 5 years ago
parent
commit
332490b877
  1. 15
      TestCentre-Breakdown.md

15
TestCentre-Breakdown.md

@ -1,6 +1,6 @@
This project is a traditional .Net (4.7) library, written in F#. Its main purpose is to house the solution's unit and property tests.
Within the project, you will see six files and one folder. Although, you should only need to work with two of them files. They are "ConsoleTests.fs" and "LibraryTests.fs".
Within the project, you will see six files and two folders. Although, you should only need to work with two of them files. They are "ConsoleTests.fs" and "LibraryTests.fs".
FILE BREAKDOWN IMAGE.
@ -12,4 +12,15 @@ As their names imply, "ConsoleTests.fs" and "LibraryTests.fs" houses the tests o
IMAGE OF PROJECT SPLIT BREAK DOWN.
The folder ("SavingTestArea"), provides an area for TestCentre to actually save the images it produces. If you do not see it in your solution, you might need to create it yourself. This will become clear when you run the tests, because they will fail. If you need to add "SavingTestArea" to your copy of TestCentre, make sure it matches the location in the above diagram.
The folder ("SavingTestArea"), provides an area for TestCentre to actually save the images it produces. If you do not see it in your solution, **you might need to create it yourself**. This will become clear when you run the tests, because they will fail. If you need to add "SavingTestArea" to your copy of TestCentre, make sure it matches the location in the above diagram.
Alongside "SavingTestArea" is its counterpart, "LoadingTestArea". This is where TestCentre loads the pre-made images from to test DeathSocket's ability to add the overlays to them. Within "LoadingTestArea" is another folder called "RequiredInfo" which contains files which some tests rely on for them to pass. An example of some of the things these tests rely on is an image having certain dimensions. Usually, TestCentre generates random images to test against which means you cannot reliably check the dimensions of an image. So, do not delete the images in "RequiredInfo".
As stated above, there is a script file called "Script.fsx" included in TestCentre. The main features it provides are a way to run some of the functions in the `UnitTests` and `PropertyTests` modules in isolation and populating/resetting "LoadingTestArea" and "SavingTestArea". Before running any of the code in "Script.fsx", you will need to build the solution.
If you find any of your tests failing, cross-reference the names of the failing tests with any of the functions in "Script.fsx" to see if they can help. The most likely one is `createSavingTestArea`.
If you are unfamiliar with using F# scripts and F# Interactive (FSI), please use the following links;
- [F# Interactive (FSI](https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/fsharp-interactive/)
- [Scripting with F#](https://fsharpforfunandprofit.com/installing-and-using/) (it's a little dated but it contains enough information to get you going)

Loading…
Cancel
Save