Skip to content

WIP: Add programmatic constraint examples & surface in docs #810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Oct 16, 2023
Merged

WIP: Add programmatic constraint examples & surface in docs #810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
d5b9f0c
Add and use programmatic example
SeanKilleen Oct 16, 2023
468e40b
some better formatting on the table
SeanKilleen Oct 16, 2023
a53cad3
more table formatting on constraints
SeanKilleen Oct 16, 2023
c9ec73c
Add example column
SeanKilleen Oct 16, 2023
c9fe438
rest of the columns
SeanKilleen Oct 16, 2023
ba5ed36
Example in markdown
SeanKilleen Oct 16, 2023
9fdbc7a
lint: newline
SeanKilleen Oct 16, 2023
23dc3b9
more
SeanKilleen Oct 16, 2023
6beb384
Add two one-liner examples
SeanKilleen Oct 16, 2023
6b94e1d
Move into common file to move faster
SeanKilleen Oct 16, 2023
d282698
New example
SeanKilleen Oct 16, 2023
f07479e
Fix alphabetical list
SeanKilleen Oct 16, 2023
49d4059
more
SeanKilleen Oct 16, 2023
c3638fe
Add C# devkit to devcontainer
SeanKilleen Oct 16, 2023
eb03bee
example
SeanKilleen Oct 16, 2023
7c64da3
Cast to IComparer
SeanKilleen Oct 16, 2023
7738f50
Fix constraint with note
SeanKilleen Oct 16, 2023
a067bee
Use example
SeanKilleen Oct 16, 2023
ade4f4f
more
SeanKilleen Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"shuworks.vscode-table-formatter",
"ms-dotnettools.csharp",
"github.vscode-github-actions",
"ms-azuretools.vscode-docker"
"ms-azuretools.vscode-docker",
"ms-dotnettools.csdevkit"
]
}
}
Expand Down
16 changes: 4 additions & 12 deletions docs/articles/nunit/writing-tests/constraints/AllItemsConstraint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,10 @@ AllItemsConstraint(Constraint itemConstraint)

## Syntax

```csharp
Is.All...
Has.All...
```
You can use `Is.All` or `Has.All` to refer to all items in an `IEnumerable`.

## Examples of Use

```csharp
int[] iarray = new int[] { 1, 2, 3 };
string[] sarray = new string[] { "a", "b", "c" };
Assert.That(iarray, Is.All.Not.Null);
Assert.That(sarray, Is.All.InstanceOf<string>());
Assert.That(iarray, Is.All.GreaterThan(0));
Assert.That(iarray, Has.All.GreaterThan(0));
```
[!code-csharp[IsBasedFormat](~/snippets/Snippets.NUnit/Constraints/ConstraintExamples.cs#AllItemsIsExample)]

[!code-csharp[HasBasedFormat](~/snippets/Snippets.NUnit/Constraints/ConstraintExamples.cs#AllItemsHasExample)]
4 changes: 1 addition & 3 deletions docs/articles/nunit/writing-tests/constraints/AndConstraint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ AndConstraint(Constraint left, Constraint right)

## Examples of Use

```csharp
Assert.That(2.3, Is.GreaterThan(2.0).And.LessThan(3.0));
```
[!code-csharp[AndExample](~/snippets/Snippets.NUnit/Constraints/ConstraintExamples.cs#AndExample)]

## Evaluation Order and Precedence

Expand Down
7 changes: 2 additions & 5 deletions docs/articles/nunit/writing-tests/constraints/AnyOfConstraint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@ Is.AnyOf(object[] expected)

## Examples of Use

```csharp
Assert.That(42, Is.AnyOf(0, -1, 42, 100));
[!code-csharp[AnyOfExample](~/snippets/Snippets.NUnit/Constraints/ConstraintExamples.cs#AnyOfExample)]

// You can use a custom comparer as well
Assert.That(myOwnObject, Is.AnyOf(myArray).Using(myComparer));
```
[!code-csharp[AnyOfWithCustomComparison](~/snippets/Snippets.NUnit/Constraints/ConstraintExamples.cs#AnyOfWithCustomComparison)]
5 changes: 1 addition & 4 deletions docs/articles/nunit/writing-tests/constraints/AssignableFromConstraint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,4 @@ Is.AssignableFrom<T>()

## Examples of Use

```csharp
Assert.That("Hello", Is.AssignableFrom(typeof(string)));
Assert.That(5, Is.Not.AssignableFrom(typeof(string)));
```
[!code-csharp[AssignableFromExample](~/snippets/Snippets.NUnit/Constraints/ConstraintExamples.cs#AssignableFromExample)]
228 changes: 115 additions & 113 deletions docs/articles/nunit/writing-tests/constraints/Constraints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,148 +4,150 @@ uid: constraints

# Constraints

<!-- markdownlint-disable MD033 -->

This page lists all the constraints available in NUnit.

* [Alphabetical List of Constraints](#alphabetical-list-of-constraints)
* [Constraints by Category](#constraints-by-category)

## Alphabetical List of Constraints

Constraint Name |
-------------------------------------|
[AllItemsConstraint](AllItemsConstraint.md) |
[AndConstraint](AndConstraint.md) |
[AssignableFromConstraint](AssignableFromConstraint.md) |
[AssignableToConstraint](AssignableToConstraint.md) |
[AttributeConstraint](AttributeConstraint.md) |
[AttributeExistsConstraint](AttributeExistsConstraint.md) |
[AnyOfConstraint](AnyOfConstraint.md) |
[BinarySerializableConstraint](BinarySerializableConstraint.md) |
[CollectionContainsConstraint](CollectionContainsConstraint.md) |
[CollectionEquivalentConstraint](CollectionEquivalentConstraint.md) |
[CollectionOrderedConstraint](CollectionOrderedConstraint.md) |
[CollectionSubsetConstraint](CollectionSubsetConstraint.md) |
[CollectionSupersetConstraint](CollectionSupersetConstraint.md) |
[DelayedConstraint](DelayedConstraint.md) |
[DictionaryContainsKeyConstraint](DictionaryContainsKeyConstraint.md) |
[DictionaryContainsKeyValuePairConstraint](DictionaryContainsKeyValuePairConstraint.md) |
[DictionaryContainsValueConstraint](DictionaryContainsValueConstraint.md)|
[EmptyCollectionConstraint](EmptyCollectionConstraint.md) |
[EmptyConstraint](EmptyConstraint.md) |
[EmptyDirectoryConstraint](EmptyDirectoryConstraint.md) |
[EmptyStringConstraint](EmptyStringConstraint.md) |
[EndsWithConstraint](EndsWithConstraint.md) |
[EqualConstraint](EqualConstraint.md) |
[ExactCountConstraint](ExactCountConstraint.md) |
[ExactTypeConstraint](ExactTypeConstraint.md) |
[FalseConstraint](FalseConstraint.md) |
[FileOrDirectoryExistsConstraint](FileOrDirectoryExistsConstraint.md) |
[GreaterThanConstraint](GreaterThanConstraint.md) |
[GreaterThanOrEqualConstraint](GreaterThanOrEqualConstraint.md) |
[InstanceOfTypeConstraint](InstanceOfTypeConstraint.md) |
[LessThanConstraint](LessThanConstraint.md) |
[LessThanOrEqualConstraint](LessThanOrEqualConstraint.md) |
[NaNConstraint](NaNConstraint.md) |
[NoItemConstraint](NoItemConstraint.md) |
[NotConstraint](NotConstraint.md) |
[NullConstraint](NullConstraint.md) |
[OrConstraint](OrConstraint.md) |
[PropertyConstraint](PropertyConstraint.md) |
[PropertyExistsConstraint](PropertyExistsConstraint.md) |
[RangeConstraint](RangeConstraint.md) |
[RegexConstraint](RegexConstraint.md) |
[ReusableConstraint](ReusableConstraint.md) |
[SameAsConstraint](SameAsConstraint.md) |
[SamePathConstraint](SamePathConstraint.md) |
[SamePathOrUnderConstraint](SamePathOrUnderConstraint.md) |
[SomeItemsConstraint](SomeItemsConstraint.md) |
[StartsWithConstraint](StartsWithConstraint.md) |
[SubPathConstraint](SubPathConstraint.md) |
[SubstringConstraint](SubstringConstraint.md) |
[ThrowsConstraint](ThrowsConstraint.md) |
[ThrowsNothingConstraint](ThrowsNothingConstraint.md) |
[TrueConstraint](TrueConstraint.md) |
[UniqueItemsConstraint](UniqueItemsConstraint.md) |
[XmlSerializableConstraint](XmlSerializableConstraint.md) |
| Constraint Name | Quick Example |
| ------------------------------------- | ------------- |
| [AllItemsConstraint](AllItemsConstraint.md) | `Assert.That(myEnumerable, Has.All.GreaterThan(32))`<br/>`Assert.That(myEnumerable, Is.All.InstanceOf<string>()` |
| [AndConstraint](AndConstraint.md) | `Assert.That(2.3, Is.GreaterThan(2.0).And.LessThan(3.0))` |
| [AnyOfConstraint](AnyOfConstraint.md) | `Assert.That(42, Is.AnyOf(0, -1, 42, 100));` |
| [AssignableFromConstraint](AssignableFromConstraint.md) | `Assert.That("Hello", Is.AssignableFrom(typeof(string)));`<br/>`Assert.That(5, Is.Not.AssignableFrom<string>());` |
| [AssignableToConstraint](AssignableToConstraint.md) | |
| [AttributeConstraint](AttributeConstraint.md) | |
| [AttributeExistsConstraint](AttributeExistsConstraint.md) | |
| [BinarySerializableConstraint](BinarySerializableConstraint.md) | |
| [CollectionContainsConstraint](CollectionContainsConstraint.md) | |
| [CollectionEquivalentConstraint](CollectionEquivalentConstraint.md) | |
| [CollectionOrderedConstraint](CollectionOrderedConstraint.md) | |
| [CollectionSubsetConstraint](CollectionSubsetConstraint.md) | |
| [CollectionSupersetConstraint](CollectionSupersetConstraint.md) | |
| [DelayedConstraint](DelayedConstraint.md) | |
| [DictionaryContainsKeyConstraint](DictionaryContainsKeyConstraint.md) | |
| [DictionaryContainsKeyValuePairConstraint](DictionaryContainsKeyValuePairConstraint.md) | |
| [DictionaryContainsValueConstraint](DictionaryContainsValueConstraint.md)| |
| [EmptyCollectionConstraint](EmptyCollectionConstraint.md) | |
| [EmptyConstraint](EmptyConstraint.md) | |
| [EmptyDirectoryConstraint](EmptyDirectoryConstraint.md) | |
| [EmptyStringConstraint](EmptyStringConstraint.md) | |
| [EndsWithConstraint](EndsWithConstraint.md) | |
| [EqualConstraint](EqualConstraint.md) | |
| [ExactCountConstraint](ExactCountConstraint.md) | |
| [ExactTypeConstraint](ExactTypeConstraint.md) | |
| [FalseConstraint](FalseConstraint.md) | |
| [FileOrDirectoryExistsConstraint](FileOrDirectoryExistsConstraint.md) | |
| [GreaterThanConstraint](GreaterThanConstraint.md) | |
| [GreaterThanOrEqualConstraint](GreaterThanOrEqualConstraint.md) | |
| [InstanceOfTypeConstraint](InstanceOfTypeConstraint.md) | |
| [LessThanConstraint](LessThanConstraint.md) | |
| [LessThanOrEqualConstraint](LessThanOrEqualConstraint.md) | |
| [NaNConstraint](NaNConstraint.md) | |
| [NoItemConstraint](NoItemConstraint.md) | |
| [NotConstraint](NotConstraint.md) | |
| [NullConstraint](NullConstraint.md) | |
| [OrConstraint](OrConstraint.md) | |
| [PropertyConstraint](PropertyConstraint.md) | |
| [PropertyExistsConstraint](PropertyExistsConstraint.md) | |
| [RangeConstraint](RangeConstraint.md) | |
| [RegexConstraint](RegexConstraint.md) | |
| [ReusableConstraint](ReusableConstraint.md) | |
| [SameAsConstraint](SameAsConstraint.md) | |
| [SamePathConstraint](SamePathConstraint.md) | |
| [SamePathOrUnderConstraint](SamePathOrUnderConstraint.md) | |
| [SomeItemsConstraint](SomeItemsConstraint.md) | |
| [StartsWithConstraint](StartsWithConstraint.md) | |
| [SubPathConstraint](SubPathConstraint.md) | |
| [SubstringConstraint](SubstringConstraint.md) | |
| [ThrowsConstraint](ThrowsConstraint.md) | |
| [ThrowsNothingConstraint](ThrowsNothingConstraint.md) | |
| [TrueConstraint](TrueConstraint.md) | |
| [UniqueItemsConstraint](UniqueItemsConstraint.md) | |
| [XmlSerializableConstraint](XmlSerializableConstraint.md) | |

## Constraints by Category

### Collection Constraints
Constraint Name |
-------------------------------------|
[AllItemsConstraint](AllItemsConstraint.md) |
[AnyOfConstraint](AnyOfConstraint.md) |
[CollectionContainsConstraint](CollectionContainsConstraint.md) |
[CollectionEquivalentConstraint](CollectionEquivalentConstraint.md) |
[CollectionOrderedConstraint](CollectionOrderedConstraint.md) |
[CollectionSubsetConstraint](CollectionSubsetConstraint.md) |
[CollectionSupersetConstraint](CollectionSupersetConstraint.md) |
[DictionaryContainsKeyConstraint](DictionaryContainsKeyConstraint.md) |
[DictionaryContainsKeyValuePairConstraint](DictionaryContainsKeyValuePairConstraint.md) |
[DictionaryContainsValueConstraint](DictionaryContainsValueConstraint.md)|
[EmptyCollectionConstraint](EmptyCollectionConstraint.md) |
[ExactCountConstraint](ExactCountConstraint.md) |
[NoItemConstraint](NoItemConstraint.md) |
[SomeItemsConstraint](SomeItemsConstraint.md) |
[UniqueItemsConstraint](UniqueItemsConstraint.md) |

| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [AllItemsConstraint](AllItemsConstraint.md) | |
| [AnyOfConstraint](AnyOfConstraint.md) | |
| [CollectionContainsConstraint](CollectionContainsConstraint.md) | |
| [CollectionEquivalentConstraint](CollectionEquivalentConstraint.md) | |
| [CollectionOrderedConstraint](CollectionOrderedConstraint.md) | |
| [CollectionSubsetConstraint](CollectionSubsetConstraint.md) | |
| [CollectionSupersetConstraint](CollectionSupersetConstraint.md) | |
| [DictionaryContainsKeyConstraint](DictionaryContainsKeyConstraint.md) | |
| [DictionaryContainsKeyValuePairConstraint](DictionaryContainsKeyValuePairConstraint.md) | |
| [DictionaryContainsValueConstraint](DictionaryContainsValueConstraint.md)| |
| [EmptyCollectionConstraint](EmptyCollectionConstraint.md) | |
| [ExactCountConstraint](ExactCountConstraint.md) | |
| [NoItemConstraint](NoItemConstraint.md) | |
| [SomeItemsConstraint](SomeItemsConstraint.md) | |
| [UniqueItemsConstraint](UniqueItemsConstraint.md) | |

### Comparison Constraints

Constraint Name |
-------------------------------------|
[GreaterThanConstraint](GreaterThanConstraint.md) |
[GreaterThanOrEqualConstraint](GreaterThanOrEqualConstraint.md) |
[LessThanConstraint](LessThanConstraint.md) |
[LessThanOrEqualConstraint](LessThanOrEqualConstraint.md) |
[RangeConstraint](RangeConstraint.md) |
| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [GreaterThanConstraint](GreaterThanConstraint.md) | |
| [GreaterThanOrEqualConstraint](GreaterThanOrEqualConstraint.md) | |
| [LessThanConstraint](LessThanConstraint.md) | |
| [LessThanOrEqualConstraint](LessThanOrEqualConstraint.md) | |
| [RangeConstraint](RangeConstraint.md) | |

### Compound Constraints

Constraint Name |
-------------------------------------|
[AndConstraint](AndConstraint.md) |
[NotConstraint](NotConstraint.md) |
[OrConstraint](OrConstraint.md) |
| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [AndConstraint](AndConstraint.md) | |
| [NotConstraint](NotConstraint.md) | |
| [OrConstraint](OrConstraint.md) | |

### Condition Constraints

Constraint Name |
-------------------------------------|
[EmptyConstraint](EmptyConstraint.md) |
[FalseConstraint](FalseConstraint.md) |
[NaNConstraint](NaNConstraint.md) |
[NullConstraint](NullConstraint.md) |
[TrueConstraint](TrueConstraint.md) |
| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [EmptyConstraint](EmptyConstraint.md) | |
| [FalseConstraint](FalseConstraint.md) | |
| [NaNConstraint](NaNConstraint.md) | |
| [NullConstraint](NullConstraint.md) | |
| [TrueConstraint](TrueConstraint.md) | |

### File and Directory Constraints

Constraint Name |
-------------------------------------|
[EmptyDirectoryConstraint](EmptyDirectoryConstraint.md) |
[FileOrDirectoryExistsConstraint](FileOrDirectoryExistsConstraint.md) |
[SamePathConstraint](SamePathConstraint.md) |
[SamePathOrUnderConstraint](SamePathOrUnderConstraint.md) |
[SubPathConstraint](SubPathConstraint.md) |
| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [EmptyDirectoryConstraint](EmptyDirectoryConstraint.md) | |
| [FileOrDirectoryExistsConstraint](FileOrDirectoryExistsConstraint.md) | |
| [SamePathConstraint](SamePathConstraint.md) | |
| [SamePathOrUnderConstraint](SamePathOrUnderConstraint.md) | |
| [SubPathConstraint](SubPathConstraint.md) | |

### String Constraints

Constraint Name |
-------------------------------------|
[EmptyStringConstraint](EmptyStringConstraint.md) |
[EndsWithConstraint](EndsWithConstraint.md) |
[RegexConstraint](RegexConstraint.md) |
[StartsWithConstraint](StartsWithConstraint.md) |
[SubstringConstraint](SubstringConstraint.md) |
| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [EmptyStringConstraint](EmptyStringConstraint.md) | |
| [EndsWithConstraint](EndsWithConstraint.md) | |
| [RegexConstraint](RegexConstraint.md) | |
| [StartsWithConstraint](StartsWithConstraint.md) | |
| [SubstringConstraint](SubstringConstraint.md) | |

### Type Constraints

Constraint Name |
-------------------------------------|
[AssignableFromConstraint](AssignableFromConstraint.md) |
[AssignableToConstraint](AssignableToConstraint.md) |
[ExactTypeConstraint](ExactTypeConstraint.md) |
[InstanceOfTypeConstraint](InstanceOfTypeConstraint.md) |
| Constraint Name | Quick Example |
| -------------------------------------| ------------- |
| [AssignableFromConstraint](AssignableFromConstraint.md) | |
| [AssignableToConstraint](AssignableToConstraint.md) | |
| [ExactTypeConstraint](ExactTypeConstraint.md) | |
| [InstanceOfTypeConstraint](InstanceOfTypeConstraint.md) | |

## See also

Expand Down
Loading