AnonymousData 1.3.0
See the version list below for details.
dotnet add package AnonymousData --version 1.3.0
NuGet\Install-Package AnonymousData -Version 1.3.0
<PackageReference Include="AnonymousData" Version="1.3.0" />
paket add AnonymousData --version 1.3.0
#r "nuget: AnonymousData, 1.3.0"
// Install AnonymousData as a Cake Addin #addin nuget:?package=AnonymousData&version=1.3.0 // Install AnonymousData as a Cake Tool #tool nuget:?package=AnonymousData&version=1.3.0
AnonymousData
Why AnonymousData
Often reading tests, I need to think weather a variable used for testing, is the expected input value or it is just a value. This could be normally prevented using good coding standards and conventions, but real life is hard.
This library through the class Any, aims to help you and your team write clearer tests, but it can also be used in production code when rando data is needed.
Supported types
The following types are supported for generation:
Type | Length Limit | Unique | Other options |
---|---|---|---|
Base64String | ✔ | Prefix, CharSet | |
Bool | |||
Byte | |||
Char | CharSet | ||
DateTime | ✔ | Future | |
Decimal | ✔ | ||
Double | ✔ | ||
Enum | |||
Float | ✔ | ||
Guid | |||
Int | ✔ | ✔ | Allow Zero, Positive, Range |
Long | Positive | ||
Object | |||
SByte | |||
Short | |||
String | ✔ | Prefix, CharSet | |
TimeSpan | ✔ | ||
Uri | Protocol | ||
Url | Protocol | ||
In | |||
NotIn |
For all types it is possible to configure the exclusion of the default value of the given type.
Extra features
Unique values
When working in a test you could need to enforce that certain values are yes anonymous but also unique, for example when setting up a mocked repository which is returning different entities for different IDs. In order to force the generation of unique values you can use:
var uniqueId = Any.Unique.Int();
// Execute reset at test teardown to free memory and help generation speed
Any.ResetUniqueValues();
The use of random generation has implications which can affect performance and can even leade to memory issues. When requesting for unique values, always make sure that the set from which the values needs to be generated, is long enough to be lucky to get the first available value in a timely manner. For example generating a unique integer from a range of 100000, is going to be safe and quick, but if you require 10000 unique intergers, you might start experiencing delays and even failures. The unique generation mecanishm has a failsafe which aborts the generation and throws an exception if no random value was found in 10000 iterations.
An element in a list
Any supports the random selection of an option from a given list of options. These can be passed as an IEnumberable or as a list of parameters.
// Possible results: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday ]
var weekDays = new List<string> { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" };
var aWeekDay = Any.In(weekDays);
A random value not in a list of exclusions
Any supports the generation of a random value which won't match any of the values contained in the exclusion list. These can be passed as an IEnumberable or as a list of parameters.
// Possible results: [Sunday ]
var excludeFals = new List<bool> { false };
var alwaysTrue = Any.NotIn(exclusions);
An element of a list of parameters
Similar but alternative option is to provide a list of parameters as follows:
// Possible results: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday ]
var aWeekDay = Any.Of("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday");
Usage
Base64String
Generate a Base64 string of 15 characters
// Possible results: Any Base64 string from a string with 15 characters length
var aString = Any.Base64String();
// Possible results: Any Base64 string from a string with a length of 15 UTF-16 characters
var aUTFString = Any.Base64String(charSet: CharSet.UTF16);
Generate a Base64 string from a string with the given length
// Possible results: Any Base64 string from a string with 6 characters length
var aString = Any.Base64String(6);
Generate a Base64 string, from a stringwith the given length and prefix
// Possible results: Any string of a length of 10 characters starting with "Name_"
var aString = Any.Base64String("Name_", 10);
Strings can be generated using one the following CharSet:
- ASCII
- UTF16
- Alphanumeric The default is Alphanumeric
Bool
Get a random boolean
// Possible results: [true, false]
var aBoolean = Any.Bool();
Setting Any to exclude default values, will affect Bool() making it return always true
Any.ExcludeDefaultValues(true);
// Possible results: [true]
var alwaysTrue = Any.Bool();
Byte
Get a random Byte value between 0 and 255
// Possible results: [0, 1, ... 255]
var aByte = Any.Byte();
Setting Any to exclude default values, will affect Byte() which will never return 0
Any.ExcludeDefaultValues(true);
// Possible results: [1, ... 255]
var aByte = Any.Byte();
Char
Generates a random Char between 0 and 65535 in UTF-16*
// Possible results: [0, 1, ... 65535]
var aChar = Any.Char();
Setting Any to exclude default values, will affect Char() which will never return '0'
Any.ExcludeDefaultValues(true);
// Possible results: [1, ... 65535]
var aChar = Any.Char();
DateTime
Generate a random date time in the future, it is possible to request a date time in the past. Get a random datetime in the future
// Possible results: [DateTime from current UTC to 31/12/9999 23:59:99]
var aDateTimeInTheFuture = Any.DateTime();
Get a random datetime in the past
// Possible results: [01/01/0001 00:00 to DateTime current UTC]
var expectedResult = Any.DateTime(false);
Get a random datetime in the future but before 2090/12/31
// Possible results: [DateTime from current UTC to 31/12/2090 00:00]
var expectedResult = Any.DateTime(new DateTime(2090,12,31));
Setting Any to exclude default values, will affect DateTime() which will never return '1/1/1 0:00'
Any.ExcludeDefaultValues(true);
// Possible results: All supported DateTime excluding 1st January of the year 1 at midnight
var aDateTime = Any.DateTime(false);
Decimal
Get a dandom decimal value with by default up to 4 integer digits and 2 decimals
// Possible results: [0 ... 9999].[0 ... 99]
var aLimitedDecimal = Any.Decimal();
Get a decimal with maximum 2 integer digits and 4 decimal digits
// Possible results: [0 ... 99].[0 ... 9999]
var aLimitedDecimal = Any.Decimal(2,4);
Double
Get a random double value with by default up to 4 integer digits and 2 decimals
// Possible results: [0 ... 9999].[0 ... 99]
var aLimitedDouble = Any.Double();
Get a decimal with maximum 2 integer digits and 4 decimal digits
// Possible results: [0 ... 99].[0 ... 9999]
var aLimitedDouble = Any.Double(2,4);
An email
Extending the capability of Any.String() it is possible to have a valid formatted email address.
// Possible results: any email address with the format {any_string}@{any_string}.any
var email = Any.Email();
Float
Get a random float value with by default up to 4 integer digits and 2 decimals
// Possible results: [0 ... 9999].[0 ... 99]
var aLimitedFloat = Any.Float();
Get a decimal with maximum 2 integer digits and 4 decimal digits
// Possible results: [0 ... 99].[0 ... 9999]
var aLimitedFloat = Any.Float(2,4);
Int
Get a random integer including zero
// Possible results: [0, 1, ... Int.MaxValue]
var aPositiveInt = Any.Int();
Get a random integer of maximum 4 digits, excluding zero
// Possible results: [1, 2, ... 9998, 9999]
var aNonZeroPositiveInt = Any.Int(4, false);
Get a random integer with sign
// Possible results: [Int.MinValue ... -1, 0, 1 ... Int.MaxValue]
var anInt = Any.Int(onlyPositive: false);
Get a random integer between 600 and 1200
// Possible results: [600 ... 1200]
var anInt = Any.Int(minValue: 600, maxValue: 1200);
Setting Any to exclude default values, will affect Int() so that it will never return 0
Any.ExcludeDefaultValues(true);
// Possible results: [1, ... Int.MaxValue]
var aPositiveIntExcludingZero = Any.Int();
Long
Get a random positive long
// Possible results: 0 or [Int.MaxValue ... Int.MaxValue * 2 - 1]
// Possible results: A positive long value greater than Int.MaxValue
var aPositiveLong = Any.Long();
Get a random negative long
// Possible results: 0 or [Int.MinValue * 2 + 1 ... Int.MinValue] or [Int.MaxValue ... Int.MaxValue * 2 - 1]
// A long value greater than Int.MaxValue or lessere than Int.MinValue
var aNegativeLong = Any.Long(false);
Setting Any to exclude default values, will affect Long() which will never return 0
Any.ExcludeDefaultValues(true);
// Possible results: [Int.MaxValue ... Int.MaxValue * 2 - 1]
var aPositiveLong = Any.Long();
SByte
Generates a random signed byte with value between -128 and 127
// Possible results: [-128, ... -1, 0, 1, ... 127]
var aSByte = Any.SByte();
Setting Any to exclude default values, will affect SByte() which will never return 0
Any.ExcludeDefaultValues(true);
// Possible results: [-128, ... -1, 1, ... 127]
var aSByte = Any.SByte();
String
Generate a string of 15 characters
// Possible results: Any string of a length of 15 characters
var aString = Any.String();
// Possible results: Any string with a length of 15 UTF-16 characters
var aUTFString = Any.String(charSet: CharSet.UTF16);
Generate a string with the given length
// Possible results: Any string of a length of 6 characters
var aString = Any.String(6);
Generate a string with the given length and prefix
// Possible results: Any string of a length of 10 characters starting with "Name_"
var aString = Any.String("Name_", 10);
Strings can be generated using one the following CharSet:
- ASCII
- UTF16
- Alphanumeric The default is Alphanumeric
TimeSpan
Generates a random TimeSpan of a default maximum value of 10 days
// Possible results: Any timespan between 0 and 10 days
var aTimeSpan = Any.TimeSpan();
Generates a random TimeSpan of a maximum value of 1 hour
// Possible results: Any timespan between 0 and 1 hour
var aTimeSpan = Any.TimeSpan(0,1);
Enumertions
Get a random enumeration value
// Possible results: Any of the values in MyEnum
MyEnum anyValue = Any.In<MyEnum>();
Uri
Generates a random Uri using as default protocol http:// and default TLD .any
// Possible results: Any URL in the form http://{any_string}.any
Uri url = Any.Uri()
but is also possible to specify a custom protocol using:
// Possible results: Any URL in the form ftp://{any_string}.any
Uri url = Any.Uri("ftp")
Uri
Generates a random Url using as default protocol http:// and default TLD .any
// Possible results: Any URL in the form http://{any_string}.any
string url = Any.Url()
but is also possible to specify a custom protocol using:
// Possible results: Any URL in the form ftp://{any_string}.any
string url = Any.Url("ftp")
Objects (With default parameterless constructor)
Generate an instance of type T with random properties and fields values
// Possible results: An instance of MyType with random properties and fields
var randomObject = Any.Of<MyType>();
NOTE: for a proper Object generation, take a look at the package "Object.Builder".
Changelog
Version 1.2.0 - 18/01/2023
Bugfix
Using Any.Unique.Int()
was causing any subsequent request implicitly using Any.Int()
, to also use the Unique contraint, which could have lead to exceptions being thrown if the library was running out of valid random integers not previously generated.
Breaking changes
None
Added features
NotIn options as been added to let you generate a random value which is not contained in the list of exclusions. The returned type is the same generic type of the list of exclusions passed to the method. For example if you have a set of strings or integers you don't want to randomly generate, you can use this method.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on AnonymousData:
Package | Downloads |
---|---|
Object.Builder
Builder allows to initialize one or more objects customizing the creation. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Signed package