Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Aug 26, 2024
1 parent bccef22 commit fe4a36d
Show file tree
Hide file tree
Showing 133 changed files with 3,995 additions and 15 deletions.
12 changes: 12 additions & 0 deletions docs/mdsource/fixie-convention.include.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Fixie is less opinionated than other test frameworks. As such it leaves up to the consumer how to configure test execution.

To enable Verify the [ITestProject and IExecution interfaces](https://github.com/fixie/fixie/wiki/Customizing-the-Test-Project-Lifecycle#the-default-convention) need to be used.

Requirements:

* Assign the target assembly in `ITestProject.Configure` using `VerifierSettings.AssignTargetAssembly`
* Wrap test executions in `IExecution.Run` with a `ExecutionState.Set`

An example implementation of the above:

snippet: TestProject.cs
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Gui_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Gui_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Gui_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Rider_Cli_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Rider_Cli_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Rider_Cli_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Rider_Gui_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Rider_Gui_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Linux_Rider_Gui_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Other_Cli_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Other_Cli_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Other_Cli_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Other_Gui_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Other_Gui_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Other_Gui_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Rider_Cli_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Rider_Cli_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Rider_Cli_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Rider_Gui_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Rider_Gui_Fixie_AzureDevOps.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/MacOS_Rider_Gui_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Windows_Other_Cli_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Windows_Other_Cli_Fixie_None.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ dotnet tool install -g verify.tool

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
3 changes: 3 additions & 0 deletions docs/mdsource/wiz/Windows_Other_Gui_Fixie_AppVeyor.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ public static void Initialize() =>

snippet: SampleTestFixie


include: fixie-convention

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
Expand Down
Loading

0 comments on commit fe4a36d

Please sign in to comment.