Obsolete CollectionContainsConstraint Constructors

[ChrisMaddock]

At some point, #2239 is going to be merged and remove CollectionContainsConstraint. The only breaking change should be where anyone is explicitly using the code new CollectionContainsConstraint() - all the other methods will be changed internally to use a SomeItemsConstraint instead.

I think it would be good if we can obsolete the CollectionContainsConstraint constructor in v3.8, and then merge the actual constraint removal in v3.9. It should only be the constructor itself that is obsoleted - any other public methods which make use of the class will be refactored. The obsoletion message should state that SomeItemsConstraint is the appropriate replacement.

[ChrisMaddock]

D'oh - sorry @mikkelbu - I meant to tag you in this and ask if you wanted to do it!

[mikkelbu]

No problem 😄. I just needed a simple task after my vacation.

[mikkelbu]

@ChrisMaddock Just a question (I forgot about @CharliePoole's #1324 (comment)). Adding the ObsoleteAttribute to the constructor gives the the following errors when compiling, so I'll need to do most of the same changes as in #2239 (except removing the class) in order to be able to compile the solution.

Has.cs(218,20): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Does.cs(68,20): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Contains.cs(44,20): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Assert.cs(301,33): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Assert.cs(311,33): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Constraints\DictionaryContainsValueConstraint.cs(40,13): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated,use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Constraints\DictionaryContainsKeyConstraint.cs(40,13): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Constraints\ContainsConstraint.cs(84,35): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Constraints\ConstraintExpression.cs(729,62): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
Constraints\ConstraintExpression.cs(742,62): error CS0618: 'CollectionContainsConstraint.CollectionContainsConstraint(object)' is obsolete: 'Deprecated, use 'new SomeItemsConstraint(new EqualConstraint(expected))' or 'Has.Some.EqualTo(expected)' instead.' [C:\src\NUnit\nunit\src\NUnitFramework\framework\nunit.framework-4.5.csproj]
An error occurred when executing task 'Build45'.

[ChrisMaddock]

Is it possible to disable the warnings with pragma's around the relevant lines?

i.e.

#pragma warning disable 618
new CollectionContainsConstraint()
#pragma warning restore 618

[ChrisMaddock]

If not, maybe a solution is to merge #2239 - just without the classes removed, and the constructors obsoleted instead. Then in 3.9, it will just be a matter of deleting an unused class. 😄

[CharliePoole]

@ChrisMaddock Sounds like a plan.

[mikkelbu]

@ChrisMaddock I think that I will go for the second approach (reintroducing the classes in #2239 and mark the constructors as obsolete). Hopefully, I will have time for it this week.

[ChrisMaddock]

Great! 😀 3.8's come up quick - I need to carve some time out to sort the issues I was going to too! 😆

[rprouse]

@mikkelbu I am starting to prepare the 3.8 release. Should I expect a PR for this soon or should I move it out of the release milestone?