Bogus for .NET: C#, F#, and VB.NET
Project Description
Hello. I'm your host Brian Chavez (twitter). Bogus is a simple and sane fake data generator for .NET languages like C#, F# and VB.NET. Bogus is fundamentally a C# port of faker.js
and inspired by FluentValidation
's syntax sugar.
Bogus will help you load databases, UI and apps with fake data for your testing needs. If you like Bogus star
Download & Install
Nuget Package Bogus
Install-Package Bogus
Minimum Requirements: .NET Standard 1.3 or .NET Standard 2.0 or .NET Framework 4.0.
Projects That Use Bogus
- Elasticsearch .NET Client (NEST) [code]
- GraphQL for .NET [code]
- Microsoft Windows-XAML / Template10 [code]
- Microsoft Learning / Developing Microsoft Azure Solutions [code]
- Microsoft Office Developer
Featured In
- Microsoft Docs: Modernize a WPF app tutorial - Aug. 2nd, 2019
- Microsoft Build 2018: Azure Tips and Tricks - May 8th, 2018
- NuGet Must Haves: Top 10 Unit Testing Libraries in 2017
- .NET Rocks Podcast: #BetterKnowThatFramework - Mar. 16th 2017, Sep. 13th, 2018, and May 7th, 2020
- .NET Engineering Blog: NuGet Package of the week #1. - "This week in .NET - December 8th 2015"
Blog Posts
- Nick Chapsas - Generating realistic fake data in .NET using Bogus [YouTube]
- Jack Histon - How to Create Bogus Data in C#
- Christos Matskas - Creating .NET fakes using Bogus
- Jason Roberts - Lifelike Test Data Generation with Bogus
- Mark Timmings - Auto generating test data with Bogus
- .NET Core Generating Test Data
- Steve Leigh - Seedy Fake Users
- Dominik Roszkowski - Bogus fake data generator in .Net testing
- Volkan Paksoy - Generating Test Data with Bogus
- Alican Demirtas - Bogus on F#
The Crypto Tip Jar!
π Dogecoin:D6Y9oaf963cgcjp6AgD6sDWWLTXGGYx9r2
Usage
The Great C# Example
public enum Gender
{
Male,
Female
}
//Set the randomizer seed if you wish to generate repeatable data sets.
Randomizer.Seed = new Random(8675309);
var fruit = new[] { "apple", "banana", "orange", "strawberry", "kiwi" };
var orderIds = 0;
var testOrders = new Faker<Order>()
//Ensure all properties have rules. By default, StrictMode is false
//Set a global policy by using Faker.DefaultStrictMode
.StrictMode(true)
//OrderId is deterministic
.RuleFor(o => o.OrderId, f => orderIds++)
//Pick some fruit from a basket
.RuleFor(o => o.Item, f => f.PickRandom(fruit))
//A random quantity from 1 to 10
.RuleFor(o => o.Quantity, f => f.Random.Number(1, 10))
//A nullable int? with 80% probability of being null.
//The .OrNull extension is in the Bogus.Extensions namespace.
.RuleFor(o => o.LotNumber, f => f.Random.Int(0, 100).OrNull(f, .8f));
var userIds = 0;
var testUsers = new Faker<User>()
//Optional: Call for objects that have complex initialization
.CustomInstantiator(f => new User(userIds++, f.Random.Replace("###-##-####")))
//Use an enum outside scope.
.RuleFor(u => u.Gender, f => f.PickRandom<Gender>())
//Basic rules using built-in generators
.RuleFor(u => u.FirstName, (f, u) => f.Name.FirstName(u.Gender))
.RuleFor(u => u.LastName, (f, u) => f.Name.LastName(u.Gender))
.RuleFor(u => u.Avatar, f => f.Internet.Avatar())
.RuleFor(u => u.UserName, (f, u) => f.Internet.UserName(u.FirstName, u.LastName))
.RuleFor(u => u.Email, (f, u) => f.Internet.Email(u.FirstName, u.LastName))
.RuleFor(u => u.SomethingUnique, f => $"Value {f.UniqueIndex}")
//Use a method outside scope.
.RuleFor(u => u.CartId, f => Guid.NewGuid())
//Compound property with context, use the first/last name properties
.RuleFor(u => u.FullName, (f, u) => u.FirstName + " " + u.LastName)
//And composability of a complex collection.
.RuleFor(u => u.Orders, f => testOrders.Generate(3).ToList())
//Optional: After all rules are applied finish with the following action
.FinishWith((f, u) =>
{
Console.WriteLine("User Created! Id={0}", u.Id);
});
var user = testUsers.Generate();
Console.WriteLine(user.DumpAsJson());
/* OUTPUT:
User Created! Id=0
*
{
"Id": 0,
"FirstName": "Audrey",
"LastName": "Spencer",
"FullName": "Audrey Spencer",
"UserName": "Audrey_Spencer72",
"Email": "Audrey82@gmail.com",
"Avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/itstotallyamy/128.jpg",
"CartId": "863f9462-5b88-471f-b833-991d68db8c93",
"SSN": "923-88-4231",
"Gender": 0,
"Orders": [
{
"OrderId": 0,
"Item": "orange",
"Quantity": 8
},
{
"OrderId": 1,
"Item": "banana",
"Quantity": 2
},
{
"OrderId": 2,
"Item": "kiwi",
"Quantity": 9
}
]
} */
Click here for F# and VB.NET examples!
Locales
Since we're a port of faker.js, we support a whole bunch of different locales. Here's an example in Korean:
[Test]
public void With_Korean_Locale()
{
var lorem = new Bogus.DataSets.Lorem(locale: "ko");
Console.WriteLine(lorem.Sentence(5));
}
/* κ΅κ°λ 무μμΌλ‘ νμλ‘ μ무λ₯Ό ꡬμ±νμ§ μ 체μ μ²λ²λ°μ§ μμ κ°μ κ²½μ°μ */
Bogus supports the following locales:
Locale Code | Language | Locale Code | Language | |
---|---|---|---|---|
af_ZA |
Afrikaans | fr_CH |
French (Switzerland) | |
ar |
Arabic | ge |
Georgian | |
az |
Azerbaijani | hr |
Hrvatski | |
cz |
Czech | id_ID |
Indonesia | |
de |
German | it |
Italian | |
de_AT |
German (Austria) | ja |
Japanese | |
de_CH |
German (Switzerland) | ko |
Korean | |
el |
Greek | lv |
Latvian | |
en |
English | nb_NO |
Norwegian | |
en_AU |
English (Australia) | nep |
Nepalese | |
en_au_ocker |
English (Australia Ocker) | nl |
Dutch | |
en_BORK |
English (Bork) | nl_BE |
Dutch (Belgium) | |
en_CA |
English (Canada) | pl |
Polish | |
en_GB |
English (Great Britain) | pt_BR |
Portuguese (Brazil) | |
en_IE |
English (Ireland) | pt_PT |
Portuguese (Portugal) | |
en_IND |
English (India) | ro |
Romanian | |
en_NG |
Nigeria (English) | ru |
Russian | |
en_US |
English (United States) | sk |
Slovakian | |
en_ZA |
English (South Africa) | sv |
Swedish | |
es |
Spanish | tr |
Turkish | |
es_MX |
Spanish (Mexico) | uk |
Ukrainian | |
fa |
Farsi | vi |
Vietnamese | |
fi |
Finnish | zh_CN |
Chinese | |
fr |
French | zh_TW |
Chinese (Taiwan) | |
fr_CA |
French (Canada) | zu_ZA |
Zulu (South Africa) |
Note: Some locales may not have a complete data set. For example, zh_CN
does not have a lorem
data set, but ko
has a lorem
data set. Bogus will default to en
if a locale-specific data set is not found. To further illustrate the previous example, the missing zh_CN:lorem
data set will default to the en:lorem
data set.
If you'd like to help contribute new locales or update existing ones please see our Creating Locales wiki page for more info.
Without Fluent Syntax
You can use Bogus without a fluent setup. The examples below highlight three alternative ways to use Bogus without a fluent syntax setup.
- Using the
Faker
facade. - Using DataSets directly.
- Using
Faker<T>
inheritance.
Faker
facade:
Using the public void Using_The_Faker_Facade()
{
var faker = new Faker("en");
var o = new Order()
{
OrderId = faker.Random.Number(1, 100),
Item = faker.Lorem.Sentence(),
Quantity = faker.Random.Number(1, 10)
};
o.Dump()
}
Using DataSets directly:
public void Using_DataSets_Directly()
{
var random = new Bogus.Randomizer();
var lorem = new Bogus.DataSets.Lorem("en");
var o = new Order()
{
OrderId = random.Number(1, 100),
Item = lorem.Sentence(),
Quantity = random.Number(1, 10)
};
o.Dump();
}
Faker<T>
inheritance:
Using public class OrderFaker : Faker<Order> {
public OrderFaker() {
RuleFor(o => o.OrderId, f => f.Random.Number(1, 100));
RuleFor(o => o.Item, f => f.Lorem.Sentence());
RuleFor(o => o.Quantity, f => f.Random.Number(1, 10));
}
}
public void Using_FakerT_Inheritance()
{
var orderFaker = new OrderFaker();
var o = orderFaker.Generate();
o.Dump();
}
In the examples above, all three alternative styles of using Bogus produce the same Order
result:
{
"OrderId": 61,
"Item": "vel est ipsa",
"Quantity": 7
}
Bogus API Support
Address
ZipCode
- Get a zipcode.City
- Get a city name.StreetAddress
- Get a street address.CityPrefix
- Get a city prefix.CitySuffix
- Get a city suffix.StreetName
- Get a street name.BuildingNumber
- Get a building number.StreetSuffix
- Get a street suffix.SecondaryAddress
- Get a secondary address like 'Apt. 2' or 'Suite 321'.County
- Get a county.Country
- Get a country.FullAddress
- Get a full address like Street, City, Country.CountryCode
- Get a random ISO 3166-1 country code.State
- Get a random state state.StateAbbr
- Get a state abbreviation.Latitude
- Get a Latitude.Longitude
- Get a Longitude.Direction
- Generates a cardinal or ordinal direction. IE: Northwest, South, SW, E.CardinalDirection
- Generates a cardinal direction. IE: North, South, E, W.OrdinalDirection
- Generates an ordinal direction. IE: Northwest, Southeast, SW, NE.
Commerce
Department
- Get a random commerce department.Price
- Get a random product price.Categories
- Get random product categories.ProductName
- Get a random product name.Color
- Get a random color.Product
- Get a random product.ProductAdjective
- Random product adjective.ProductMaterial
- Random product material.Ean8
- Get a random EAN-8 barcode number.Ean13
- Get a random EAN-13 barcode number.
Company
CompanySuffix
- Get a company suffix. "Inc" and "LLC" etc.CompanyName
- Get a company name.CatchPhrase
- Get a company catch phrase.Bs
- Get a company BS phrase.
Database
Column
- Generates a column name.Type
- Generates a column type.Collation
- Generates a collation.Engine
- Generates a storage engine.
Date
Past
- Get aDateTime
in the past betweenrefDate
andyearsToGoBack
.PastOffset
- Get aDateTimeOffset
in the past betweenrefDate
andyearsToGoBack
.Soon
- Get aDateTime
that will happen soon.SoonOffset
- Get aDateTimeOffset
that will happen soon.Future
- Get aDateTime
in the future betweenrefDate
andyearsToGoForward
.FutureOffset
- Get aDateTimeOffset
in the future betweenrefDate
andyearsToGoForward
.Between
- Get a randomDateTime
betweenstart
andend
.BetweenOffset
- Get a randomDateTimeOffset
betweenstart
andend
.Recent
- Get a randomDateTime
within the last few days.RecentOffset
- Get a randomDateTimeOffset
within the last few days.Timespan
- Get a randomTimeSpan
.Month
- Get a random monthWeekday
- Get a random weekday
Finance
Account
- Get an account number. Default length is 8 digits.AccountName
- Get an account name. Like "savings", "checking", "Home Loan" etc..Amount
- Get a random amount. Default 0 - 1000.TransactionType
- Get a transaction type: "deposit", "withdrawal", "payment", or "invoice".Currency
- Get a random currency.CreditCardNumber
- Generate a random credit card number with valid Luhn checksum.CreditCardCvv
- Generate a credit card CVVBitcoinAddress
- Generates a random Bitcoin address.EthereumAddress
- Generate a random Ethereum address.RoutingNumber
- Generates an ABA routing number with valid check digit.Bic
- Generates Bank Identifier Code (BIC) code.Iban
- Generates an International Bank Account Number (IBAN).
Hacker
Abbreviation
- Returns an abbreviation.Adjective
- Returns a adjective.Noun
- Returns a noun.Verb
- Returns a verb.IngVerb
- Returns a verb ending with -ing.Phrase
- Returns a phrase.
Images
DataUri
- Get a SVG data URI image with a specific width and height.PicsumUrl
- Get an image from the https://picsum.photos service.PlaceholderUrl
- Get an image from https://placeholder.com service.LoremFlickrUrl
- Get an image from https://loremflickr.com service.LoremPixelUrl
- Creates an image URL with http://lorempixel.com. Note: This service is slow. Consider using PicsumUrl() as a faster alternative.Abstract
- Gets an abstract looking image.Animals
- Gets an image of an animal.Business
- Gets a business looking image.Cats
- Gets a picture of a cat.City
- Gets a city looking image.Food
- Gets an image of food.Nightlife
- Gets an image with city looking nightlife.Fashion
- Gets an image in the fashion category.People
- Gets an image of humans.Nature
- Gets an image of nature.Sports
- Gets an image related to sports.Technics
- Get a technology related image.Transport
- Get a transportation related image.
Internet
Avatar
- Generates a legit Internet URL avatar from twitter accounts.Email
- Generates an email address.ExampleEmail
- Generates an example email with @example.com.UserName
- Generates user names.UserNameUnicode
- Generates a user name preserving Unicode characters.DomainName
- Generates a random domain name.DomainWord
- Generates a domain word used for domain names.DomainSuffix
- Generates a domain name suffix like .com, .net, .orgIp
- Gets a random IPv4 address string.IpAddress
- Gets a random IPv4 IPAddress type.IpEndPoint
- Gets a random IPv4 IPEndPoint.Ipv6
- Generates a random IPv6 address string.Ipv6Address
- Generate a random IPv6 IPAddress type.Ipv6EndPoint
- Gets a random IPv6 IPEndPoint.UserAgent
- Generates a random user agent.Mac
- Gets a random mac address.Password
- Generates a random password.Color
- Gets a random aesthetically pleasing color near the base RGB. See here.Protocol
- Returns a random protocol. HTTP or HTTPS.Url
- Generates a random URL.UrlWithPath
- Get an absolute URL with random path.UrlRootedPath
- Get a rooted URL path like: /foo/bar. Optionally with file extension.
Lorem
Word
- Get a random lorem word.Words
- Get an array of random lorem words.Letter
- Get a character letter.Sentence
- Get a random sentence of specific number of words.Sentences
- Get some sentences.Paragraph
- Get a paragraph.Paragraphs
- Get a specified number of paragraphs.Text
- Get random text on a random lorem methods.Lines
- Get lines of lorem.Slug
- Slugify lorem words.
Name
FirstName
- Get a first name. Getting a gender specific name is only supported on locales that support it.LastName
- Get a last name. Getting a gender specific name is only supported on locales that support it.FullName
- Get a full name, concatenation of calling FirstName and LastName.Prefix
- Gets a random prefix for a name.Suffix
- Gets a random suffix for a name.FindName
- Gets a full name.JobTitle
- Gets a random job title.JobDescriptor
- Get a job description.JobArea
- Get a job area expertise.JobType
- Get a type of job.
Phone
PhoneNumber
- Get a phone number.PhoneNumberFormat
- Gets a phone number based on the locale's phone_number.formats[] array index.
Rant
Review
- Generates a random user review.Reviews
- Generate an array of random reviews.
System
FileName
- Get a random file name.DirectoryPath
- Get a random directory path (Unix).FilePath
- Get a random file path (Unix).CommonFileName
- Generates a random file name with a common file extension.MimeType
- Get a random mime typeCommonFileType
- Returns a commonly used file type.CommonFileExt
- Returns a commonly used file extension.FileType
- Returns any file type available as mime-type.FileExt
- Gets a random extension for the given mime type.Semver
- Get a random semver version string.Version
- Get a randomVersion
.Exception
- Get a randomException
with a fake stack trace.AndroidId
- Get a random GCM registration ID.ApplePushToken
- Get a random Apple Push TokenBlackBerryPin
- Get a random BlackBerry Device PIN
Vehicle
Vin
- Generate a vehicle identification number (VIN).Manufacturer
- Get a vehicle manufacture name. IE: Toyota, Ford, Porsche.Model
- Get a vehicle model. IE: Camry, Civic, Accord.Type
- Get a vehicle type. IE: Minivan, SUV, Sedan.Fuel
- Get a vehicle fuel type. IE: Electric, Gasoline, Diesel.
Random
/Randomizer
Number
- Get an int from 0 to max.Digits
- Get a random sequence of digits.Even
- Returns a random even number.Odd
- Returns a random odd number.Double
- Get a random double, between 0.0 and 1.0.Decimal
- Get a random decimal, between 0.0 and 1.0.Float
- Get a random float, between 0.0 and 1.0.Byte
- Generate a random byte between 0 and 255.Bytes
- Get a random sequence of bytes.SByte
- Generate a random sbyte between -128 and 127.Int
- Generate a random int between MinValue and MaxValue.UInt
- Generate a random uint between MinValue and MaxValue.ULong
- Generate a random ulong between -128 and 127.Long
- Generate a random long between MinValue and MaxValue.Short
- Generate a random short between MinValue and MaxValue.UShort
- Generate a random ushort between MinValue and MaxValue.Char
- Generate a random char between MinValue and MaxValue.Chars
- Generate a random chars between MinValue and MaxValue.String
- Get a string of characters of a specific length.String2
- Get a string of characters with a specific length drawing characters fromchars
.Hash
- Return a random hex hash. Default 40 characters, aka SHA-1.Bool
- Get a random boolean.ArrayElement<T>
- Get a random array element.ArrayElement
- Get a random array element.ArrayElements<T>
- Get a random subset of an array.ListItem<T>
- Get a random list item.ListItems<T>
- Get a random subset of a List.CollectionItem<T>
- Get a random collection item.ReplaceNumbers
- Replaces symbols with numbers.ReplaceSymbols
- Replaces each character instance in a string.Replace
- Replaces symbols with numbers and letters. # = number, ? = letter, * = number or letter.ClampString
- Clamps the length of a string between min and max characters.Enum<T>
- Picks a random Enum of T. Works only with Enums.Shuffle<T>
- Shuffles an IEnumerable source.Word
- Returns a single word or phrase in English.Words
- Gets some random words and phrases in English.WordsArray
- Get a range of words in an array (English).Guid
- Get a random GUID.Uuid
- Get a random GUID. Alias for Randomizer.Guid().RandomLocale
- Returns a random locale.AlphaNumeric
- Returns a random set of alpha numeric characters 0-9, a-z.Hexadecimal
- Generates a random hexadecimal string.WeightedRandom<T>
- Returns a selection of T[] based on a weighted distribution of probability.
API Extension Methods
using Bogus.Extensions.Brazil;
Bogus.Person.Cpf()
- Cadastro de Pessoas FΓsicasBogus.DataSets.Company.Cnpj()
- Cadastro Nacional da Pessoa JurΓdica
using Bogus.Extensions.Canada;
Bogus.Person.Sin()
- Social Insurance Number for Canada
using Bogus.Extensions.Denmark;
Bogus.Person.Cpr()
- Danish Personal Identification number
using Bogus.Extensions.Finland;
Bogus.Person.HenkilΓΆtunnus()
- Finnish HenkilΓΆtunnus
using Bogus.Extensions.Italy;
Bogus.Person.CodiceFiscale()
- Codice FiscaleBogus.DataSets.Finance.CodiceFiscale()
- Codice Fiscale
using Bogus.Extensions.Norway;
Bogus.Person.FΓΈdselsnummer()
- Norwegian national identity number
using Bogus.Extensions.Portugal;
Bogus.Person.Nif()
- Número de Identificação Fiscal (NIF)Bogus.DataSets.Company.Nipc()
- Número de Identificação de Pessoa Colectiva (NIPC)
using Bogus.Extensions.UnitedKingdom;
Bogus.DataSets.Address.CountryOfUnitedKingdom()
- Country of the United KingdomBogus.DataSets.Finance.SortCode()
- Banking Sort CodeBogus.DataSets.Finance.Nino()
- National Insurance NumberBogus.DataSets.Vehicle.GbRegistrationPlate()
- GB Vehicle Registration Plate
using Bogus.Extensions.UnitedStates;
Bogus.Person.Ssn()
- Social Security NumberBogus.DataSets.Company.Ein()
- Employer Identification Number
using Bogus.Distributions.Gaussian;
Randomizer.GaussianInt()
- Generate anint
based on a specific normal distribution.Randomizer.GaussianFloat()
- Generate afloat
based on a specific normal distribution.Randomizer.GaussianDouble()
- Generate adouble
based on a specific normal distribution.Randomizer.GaussianDecimal()
- Generate adecimal
based on a specific normal distribution.
Amazing Community Extensions
- AutoBogus (
NuGet Package
) by @nickdodd79 - Extends Bogus by adding automatic.RuleFor()
creation and population capabilities. - NaughtyStrings.Bogus (
NuGet Package
) by @SimonCropp - Extends Bogus with list of naughty strings which have a high probability of causing issues when used as user-input data. Examples:.SQLInjection()
- Strings which can cause a SQL injection if inputs are not sanitized..ScriptInjection()
- Strings which attempt to invoke a benign script injection; shows vulnerability to XSS..iOSVulnerabilities()
- Strings which crashed iMessage in various versions of iOS..KnownCVEsandVulnerabilities()
- Strings that test for known vulnerabilities..ServerCodeInjection()
- Strings which can cause user to run code on server as a privileged user.- and more!
- WaffleGenerator.Bogus (
NuGet Package
) by @SimonCropp - The Waffle Generator produces of text which, on first glance, looks like real, ponderous, prose; replete with clichΓ©s. - NodaTime.Bogus (
NuGet Package
) by @SimonCropp - Adds support for NodaTime to Bogus. - CountryData.Bogus (
NuGet Package
) by @SimonCropp - Wrapper around GeoNames Data. Examples:.Country().Name()
- Random country name..Country().CurrencyCode()
- Random currency code..Australia().Capital()
- Country capital..Country().Iceland().PostCode()
- Random country post code.
- AustralianElectorates.Bogus (
NuGet Package
) by @SimonCropp - Wrapper around Australian Electoral Commission (AEC) data (https://www.aec.gov.au/). Examples:.AustralianElectorates().Electorate()
- Random electorate..AustralianElectorates().Name()
- Random electorate name..AustralianElectorates().CurrentMember()
- Random current electorate member for parliament..AustralianElectorates().CurrentMemberName()
- Random name of current a electorate member for parliament..AustralianElectorates().Member()
- Random electorate member for parliament..AustralianElectorates().MemberName()
- Random name of a electorate member for parliament.
Bogus Premium Extensions!
Bogus Premium [Purchase Now!] by @bchavez
You can help support the Bogus open source project by purchasing a Bogus Premium license! With an active premium license you'll be supporting this cool open-source project. You'll also gain new superpowers that extended Bogus with new features and exclusive data sets! Check 'em out below!
- Premium: Bogus.Tools.Analyzer (NuGet Package) - Save time using this handy Roslyn analyzer to generate and detect missing
.RuleFor()
rules at development & compile time! This tool is included with the Bogus Premium license! - Premium: Bogus.Locations (NuGet Package) - A dataset that contains real geographical information for places and things. Create fake GPS points and paths. Helpful for creating geodesic data for location-based aware apps.
Location
Altitude
- Generate a random altitude, in meters. Default max height is 8848m (Mount Everest). Heights are always positive.AreaCircle
- Get a latitude and longitude within a specific radius in meters.Depth
- Generate a random depth, in meters. Default max depth is -10994m (Mariana Trench). Depths are always negative.Geohash
- Generates a random Geohash. See.
- Premium: Bogus.Healthcare (NuGet Package) - A data set for the Healthcare industry. Generate fake medical records, injuries, diagnosis, drugs, dosages, human anatomy, and ICD-9 medical codes. Especially helpful in HIPAA regulated environments!
Drugs
Administration
- Get how a drug should be administered. IE: oral, nasal, injection.Dosage
- Get a drug dosage with MG unitsDosageAmount
- Get a drug dosage.DosageForm
- Get the form of a drug. IE: tablet, capsule, gel.Ingredient
- Get a drug ingredient. IE: folic acid, magnesium hydroxide, ibuprofen.Vitamin
- Get a random vitamin.
Human
BloodType
- Get a random blood type. Ex: A+, OBBodyPartExternal
- Get an external body part name. IE: Head, Arm, Leg.BodyPartInternal
- Get an internal body part name. IE: Bladder, Lung, Heart.BodyRegion
- Get a human body region. IE: Head and Neck, Thorax.BodySystem
- Get a human body system. IE: Digestive, Nervous, Circulatory.Diagnosis
- Shortcut to Icd9.DiagnosisLongDescription".InfectiousDisease
- Get an infectious disease. IE: Chickenpox, Polio, Zika Fever.Pain
- Get a human pain. Ex: Chest pain, Headache, Toothache.Plasma
- Get a random plasma type. Ex: O, A, B, ABProcedure
- Shortcut to Icd9.ProcedureLongDescription.
Icd9
DiagnosisCode
- Get a ICD9 diagnosis code.DiagnosisEntry
- Get a medical diagnosis.DiagnosisLongDescription
- Get a medical diagnosis description. IE: Meningitis due to coxsackie virus.DiagnosisShortDescription
- Get a short description of a medical diagnosis.ProcedureCode
- Get a ICD9 procedure code.ProcedureEntry
- Get a medical procedure.ProcedureLongDescription
- Get a medical procedure description.ProcedureShortDescription
- Get a short description of a medical procedure.
Icd10
DiagnosisCode
- Get a ICD10 diagnosis code.DiagnosisEntry
- Get a medical diagnosis.DiagnosisLongDescription
- Get a medical diagnosis description. IE: Meningitis due to coxsackie virus.DiagnosisShortDescription
- Get a short description of a medical diagnosis.ProcedureCode
- Get a ICD10 procedure code.ProcedureEntry
- Get a medical procedure.ProcedureLongDescription
- Get a medical procedure description.ProcedureShortDescription
- Get a short description of a medical procedure.
Medical
Hospital
- Get a random hospital.HospitalCity
- Get a hospital city.HospitalName
- Get a random hospital name. IE: UCLA Medical CenterHospitalState
- Get a hospital state.HospitalStreetAddress
- Get a hospital street address.HospitalZipCode
- Get a hospital ZipCode.Phrase
- Get a random medical phrase.Word
- Get a medical word.
- Premium: Bogus.Hollywood (NuGet Package)- A dataset for the Entertainment industry.
Movies
ActorName
- Get a famous actor. IE: Keanu Reeves, Liam Neeson, and Natalie Portman.MovieCollection
- Get a random movie collection. IE: Star Wars Collection, Indiana Jones Collection.MovieOverview
- Get a random movie overviewMovieReleaseDate
- Get a random movie release date.MovieTagline
- Get a random movie tagline.MovieTitle
- Get a random movie titleProduction
- Get a production company.
Tv
ActorName
- Get a famous actor. IE: Keanu Reeves, Liam Neeson, and Natalie Portman.Network
- Get a random TV network. IE: BBC, ABC, NBC, FOX.Production
- Get a production companySeries
- Get a name of a TV series. IE: Rick and Morty, Silicon Valley, The Walking Dead
- Premium: Bogus.Text (NuGet Package) - A dataset that contains historical texts in the public domain. Create fake sentences from famous speeches, classic books, and law
Literature
CommonSense
- Text from "Common Sense, by Thomas Paine (1776)"JfkSpeech
- Text from "JFK's Inaugural Address"Knowledge
- Text from "A Treatise Concerning the Principles of Human knowledge, by George Berkeley (1710)"
Helper Methods
The features shown below come standard with the Bogus NuGet package.
Person
If you want to generate a Person
with context relevant properties like
an email that looks like it belongs to someone with the same first/last name,
create a person!
[Test]
public void Create_Context_Related_Person()
{
var person = new Bogus.Person();
person.Dump();
}
/* OUTPUT:
{
"FirstName": "Lee",
"LastName": "Brown",
"UserName": "Lee_Brown3",
"Avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/ccinojasso1/128.jpg",
"Email": "Lee_Brown369@yahoo.com",
"DateOfBirth": "1984-01-16T21:31:27.87666",
"Address": {
"Street": "2552 Bernard Rapid",
"Suite": "Suite 199",
"City": "New Haskell side",
"ZipCode": "78425-0411",
"Geo": {
"Lat": -35.8154,
"Lng": -140.2044
}
},
"Phone": "1-500-790-8836 x5069",
"Website": "javier.biz",
"Company": {
"Name": "Kuphal and Sons",
"CatchPhrase": "Organic even-keeled monitoring",
"Bs": "open-source brand e-business"
}
} */
Replace
Replace a formatted string with random numbers #
, letters ?
, or *
random number or letter:
[Test]
public void Create_an_SSN()
{
var ssn = new Bogus.Randomizer().Replace("###-##-####");
ssn.Dump();
var code = new Randomizer().Replace("##? ??? ####");
code.Dump();
var serial = new Randomizer().Replace("**-****");
serial.Dump();
}
/* OUTPUT:
"618-19-3064"
"39E SPC 0790"
"L3-J9N5"
*/
Parse Handlebars
You can also parse strings in the following format:
[Test]
public void Handlebar()
{
var faker = new Faker();
var randomName = faker.Parse("{{name.lastName}}, {{name.firstName}} {{name.suffix}}");
randomName.Dump();
}
/* OUTPUT:
"Roob, Michale PhD"
*/
The name of a dataset is determined using DataCategory
attribute or class name otherwise. (i.e PhoneNumber
dataset in handlebars expression should be named as phone_number
)
You can pass parameters to methods using braces:
[Test]
public void HandlebarWithParameters()
{
var faker = new Faker();
var randomName = faker.Parse("{{name.firstname(Female)}}, {{name.firstname(Male)}}");
randomName.Dump();
}
/* OUTPUT:
"Lindsay, Jonathan"
*/
Implicit and Explicit Type Conversion
You can also use implicit type conversion to make your code look cleaner without having to explicitly call Faker<T>.Generate()
.
var orderFaker = new Faker<Order>()
.RuleFor(o => o.OrderId, f => f.IndexVariable++)
.RuleFor(o => o.Item, f => f.Commerce.Product())
.RuleFor(o => o.Quantity, f => f.Random.Number(1,3));
Order testOrder1 = orderFaker;
Order testOrder2 = orderFaker;
testOrder1.Dump();
testOrder2.Dump();
/* OUTPUT:
{
"OrderId": 0,
"Item": "Computer",
"Quantity": 2
}
{
"OrderId": 1,
"Item": "Tuna",
"Quantity": 3
}
*/
//Explicit works too!
var anotherOrder = (Order)orderFaker;
Bulk Rules
Sometimes writing .RuleFor(x => x.Prop, ...)
can get repetitive, use the .Rules((f, t) => {...})
shortcut to specify rules in bulk as shown below:
public void create_rules_for_an_object_the_easy_way()
{
var faker = new Faker<Order>()
.StrictMode(false)
.Rules((f, o) =>
{
o.Quantity = f.Random.Number(1, 4);
o.Item = f.Commerce.Product();
o.OrderId = 25;
});
Order o = faker.Generate();
}
Note: When using the bulk .Rules(...)
action, StrictMode
cannot be set to true
since individual properties of type T
cannot be independently checked to ensure each property has a rule.
Enumerable.Range()
and LINQ
Using The Enumerable.Range()
and LINQ are a great supplement when creating data with Bogus. Here's how to generate a simple list of email addresses:
var faker = new Faker("en");
var emailList = Enumerable.Range(1, 5)
.Select(_ => faker.Internet.Email())
.ToList();
//OUTPUT:
Gustave83@hotmail.com
Evie33@gmail.com
Abby_Wilkinson@yahoo.com
Cecilia.Hahn@yahoo.com
Jasen.Waelchi85@gmail.com
Advanced Topics, Guidance, and Best Practices
Determinism
Determinism is a first class concept in Bogus. Bogus goes to great lengths so developers can generate the same sequence of data over multiple program executions. Bogus has two strategies of setting up deterministic behavior:
-
Global Seed determinism through the
Randomizer.Seed
global static property.
Pros: Easy to get deterministic data setup quickly.
Cons: Code changes can impact other data values. Not so good for unit tests. -
Local Seed determinism through instance properties and methods. Specifically,
- The
Faker<T>.UseSeed(int)
method. - The
.Random
property on theFaker
facade and DataSets.
Pros: Code changes can be isolated with minimal impact on determinism. Good for unit tests.
Cons: Requires some forethought in design. - The
When Local Seed determinism is used to set a seed value, the global static source of randomness is ignored. This has some interesting implications as described below.
Using Global Seed determinism
The easiest way to get deterministic data values over multiple executions of a program is to set the Randomizer.Seed
property as demonstrated below:
Randomizer.Seed = new Random(1338);
var orderIds = 0;
var orderFaker = new Faker<Order>()
.RuleFor(o => o.OrderId, f => orderIds++)
.RuleFor(o => o.Item, f => f.Commerce.Product())
.RuleFor(o => o.Quantity, f => f.Random.Number(1, 5));
orderFaker.Generate(5).Dump();
OrderId | Item | Quantity |
---|---|---|
0 | Fish | 3 |
1 | Chair | 1 |
2 | Gloves | 5 |
3 | Shirt | 4 |
4 | Hat | 4 |
Re-running the code above with 1338
as a global static seed value will produce the same table of data over and over again.
Next, add a new Description
property to the Order
class along with a new .RuleFor(o => o.Description, ..)
rule and see the data changes:
Randomizer.Seed = new Random(1338);
var orderIds = 0;
var orderFaker = new Faker<Order>()
.RuleFor(o => o.OrderId, f => orderIds++)
.RuleFor(o => o.Item, f => f.Commerce.Product())
.RuleFor(o => o.Description, f => f.Commerce.ProductAdjective()) //New Rule
.RuleFor(o => o.Quantity, f => f.Random.Number(1, 5));
orderFaker.Generate(5).Dump();
OrderId | Item | Description | Quantity |
---|---|---|---|
0 | Fish | Fantastic | |
1 | |||
2 | |||
3 | |||
4 |
A couple of observations:
Order 0: Item
valueFish
remained the same.Order 0: Quantity
changed from3
to1
.Order 1: Item
has changed from aChair
to aKeyboard
.
In fact, every data value with a
Using Local Seed determinism
Making use of the Faker<T>.UseSeed(int)
method can help limit the impact of POCO schema changes on deterministic data values that span across an entire run. Consider the following code that uses a seed value for each instance of a POCO object:
var orderIds = 0;
var orderFaker = new Faker<Order>()
.RuleFor(o => o.OrderId, f => orderIds++)
.RuleFor(o => o.Item, f => f.Commerce.Product())
.RuleFor(o => o.Quantity, f => f.Random.Number(1, 5));
Order SeededOrder(int seed){
return orderFaker.UseSeed(seed).Generate();
}
var orders = Enumerable.Range(1, 5)
.Select(SeededOrder)
.ToList();
orders.Dump();
OrderId | Item | Quantity |
---|---|---|
0 | Bike | 1 |
1 | Cheese | 3 |
2 | Gloves | 4 |
3 | Bacon | 5 |
4 | Pants | 2 |
Next, adding the Description
property to the Order
class and examining the output:
var orderIds = 0;
var orderFaker = new Faker<Order>()
.RuleFor(o => o.OrderId, f => orderIds++)
.RuleFor(o => o.Item, f => f.Commerce.Product())
.RuleFor(o => o.Description, f => f.Commerce.ProductAdjective()) //New Rule
.RuleFor(o => o.Quantity, f => f.Random.Number(1, 5));
Order SeededOrder(int seed){
return orderFaker.UseSeed(seed).Generate();
}
var orders = Enumerable.Range(1,5)
.Select(SeededOrder)
.ToList();
orders.Dump();
OrderId | Item | Description | Quantity |
---|---|---|---|
0 | Bike | Ergonomic | |
1 | Cheese | Fantastic | |
2 | Gloves | Handcrafted | |
3 | Bacon | Tasty | |
4 | Pants | Gorgeous |
Progress! This time only the Quantity
data values with the Item
column remained the same before and after the new addition of the Description
property.
We can further prevent the Quantity
data values from changing by moving the RuleFor(o => o.Description,...)
rule line to the end of the Faker<Order>
declaration as shown below:
var orderIds = 0;
var orderFaker = new Faker<Order>()
.RuleFor(o => o.OrderId, f => orderIds++)
.RuleFor(o => o.Item, f => f.Commerce.Product())
.RuleFor(o => o.Quantity, f => f.Random.Number(1, 5))
.RuleFor(o => o.Description, f => f.Commerce.ProductAdjective()); //New Rule
Order MakeOrder(int seed){
return orderFaker.UseSeed(seed).Generate();
}
var orders = Enumerable.Range(1,5)
.Select(MakeOrder)
.ToList();
orders.Dump();
OrderId | Item | Quantity | Description |
---|---|---|---|
0 | Bike | 1 | Practical |
1 | Cheese | 3 | Rustic |
2 | Gloves | 4 | Refined |
3 | Bacon | 5 | Awesome |
4 | Pants | 2 | Gorgeous |
Much success! Item
and Quantity
values remain unchanged! The new Description
property is added to the POCO object without any impact to other deterministic data values.
As a best practice, to achieve maximum deterministic behavior and unit test robustness with Bogus:
βοΈ Add newRuleFor
rules last inFaker<T>
declarations.βοΈ Avoid changing existing rules.βοΈ Always useFaker<T>.UseSeed(int)
to avoid using the global static seed as a source for randomness.βοΈ When possible assert that a value exists, not the literal value itself. In other words,// Don't do this: firstOrder.Item.Should().Be("Bike"); // Instead, do this: firstOrder.Item.Should().NotBeNullOrWhiteSpace();
The Faker
facade and individual DataSets can also be prepared to use local seeds as well. The following shows how to set up the Faker
facade and DataSets to use local seeds:
var faker = new Faker("en")
{
Random = new Randomizer(1338)
};
var lorem = new Bogus.DataSets.Lorem("en"){
Random = new Randomizer(1338)
};
faker.Lorem.Word().Dump();
lorem.Word().Dump();
//OUTPUT:
minus
minus
The .Random
property can be set multiple times without any ill effects.
Versioning can effect determinism
Updating to new versions of Bogus on NuGet can effect determinism too. For example, when Bogus updates locales from faker.js or issues bug fixes, sometimes deterministic sequences can change. Changes to deterministic outputs are usually highlighted in the release notes. Changes to deterministic outputs is also considered a breaking change. Bogus generally follows semantic versioning rules. For example:
Version | Description |
---|---|
Bogus v25.0.1 | Initial version. |
Bogus v25.0.2 | No change to deterministic outputs or breaking changes. Possible bug fixes & improvements. |
Bogus v26.0.1 | Deterministic outputs may have changed or may include other breaking changes. |
As a general rule of thumb,
βοΈ For maximum stability for unit tests, stay within the same major versions of Bogus.βοΈ For those wanting to stay up to date, assert that a value exists, not a literal value itself. In other words,// Don't do this: firstOrder.Item.Should().Be("Bike"); // Instead, do this: firstOrder.Item.Should().NotBeNullOrWhiteSpace();
Deterministic Dates and Times
Bogus can generate deterministic dates and times. However, generating deterministic dates and times requires the following:
- Setting up a local or global seed value.
- Setting up a global anchor source of time in
Bogus.DataSets.Date.SystemClock
.
The following code shows how to setup deterministic dates and times:
// Setup some kind of seed, global or local. Here, we use a global seed.
Randomizer.Seed = new Random(1338);
// Setup a static source of time.
Bogus.DataSets.Date.SystemClock = () => DateTime.Parse("8/8/2019 2:00 PM");
// Now use Bogus as you normally would. All dates and times
// generated by Bogus should now be deterministic.
var p = new Person();
p.DateOfBirth; // 1996-06-09T15:38:11
var f = new Faker();
f.Date.Past(); // 2018-09-29T07:42:26
f.Date.Future(); // 2020-02-13T08:10:27
With the Bogus.DataSets.Date.SystemClock
set and a local or global seed, dates and times should be deterministic across multiple runs of a program.
F# and VB.NET Examples
The Fabulous F# Examples
- Using the
Faker
facade with immutable F# record types:
type Customer = { FirstName : string
LastName : string
Age : int
Title : string }
//The faker facade
let f = Faker();
let generator() =
{ FirstName = f.Name.FirstName()
LastName = f.Name.LastName()
Age = f.Random.Number(18,60)
Title = f.Name.JobTitle() }
generator() |> Dump |> ignore
(* OUTPUT:
FirstName = "Russell"
LastName = "Nader"
Age = 34
Title = "Senior Web Officer"
*)
- Using the
Faker<T>
class with immutable F# record types:
type Customer = { FirstName : string
LastName : string
Age : int
Title : string }
let customerFaker =
Bogus
.Faker<Customer>()
.CustomInstantiator(fun f ->
{ FirstName = f.Name.FirstName()
LastName = f.Name.LastName()
Age = f.Random.Number(18,60)
Title = f.Name.JobTitle() })
customerFaker.Generate() |> Dump |> ignore
(* OUTPUT:
FirstName = "Sasha"
LastName = "Roberts"
Age = 20;
Title = "Internal Security Specialist"
*)
- Using the
Faker<T>
class with mutable classes in F#:
open Bogus
type Customer() =
member val FirstName = "" with get, set
member val LastName = "" with get, set
member val Age = 0 with get, set
member val Title = "" with get, set
let faker =
Faker<Customer>()
//Make a rule for each property
.RuleFor( (fun c -> c.FirstName), fun (f:Faker) -> f.Name.FirstName() )
.RuleFor( (fun c -> c.LastName), fun (f:Faker) -> f.Name.LastName() )
//Or, alternatively, in bulk with .Rules()
.Rules( fun f c ->
c.Age <- f.Random.Int(18,35)
c.Title <- f.Name.JobTitle() )
faker.Generate() |> Dump |> ignore
(* OUTPUT:
FirstName: Jarrell
LastName: Tremblay
Age: 32
Title: Senior Web Designer
*)
The Very Basic VB.NET Example
Imports Bogus
Public Class Customer
Public Property FirstName() As String
Public Property LastName() As String
Public Property Age() As Integer
Public Property Title() As String
End Class
Sub Main
Dim faker As New Faker(Of Customer)
'-- Make a rule for each property
faker.RuleFor( Function(c) c.FirstName, Function(f) f.Name.FirstName) _
.RuleFor( Function(c) c.LastName, Function(f) f.Name.LastName) _
_
.Rules( Sub(f, c) '-- Or, alternatively, in bulk with .Rules()
c.Age = f.Random.Int(18,35)
c.Title = f.Name.JobTitle()
End Sub )
faker.Generate.Dump
End Sub
' OUTPUT:
' FirstName: Jeremie
' LastName: Mills
' Age: 32
' Title: Quality Supervisor
Building From Source
The following section is only useful for people looking to contribute to Bogus or make custom modifications to Bogus. This section includes information about building Bogus from source code and is not required to operate or run Bogus in .NET applications.
The minimum requirements to build Bogus from source code are as follows:
- Windows 7 or later.
- Git for Windows
v2.17.1
or later. - .NET Framework
v4.7.1
. - .NET Core SDK
SDK v3.1.100
or later. - Optional: IDE with C# 8 support.
- Visual Studio 2019 or later.
Build Instructions
- Download the source code.
- Open command prompt and run
build.cmd
:build clean
- cleans sources and files.build restore
- restores all project references.build dnx
- the main dotnet build task.build zip
- creates a nice zip file with debug and release binaries.build nuget
- builds NuGet packages.build test
- runs all unit tests.
Upon a successful build, the following folders will be created:
\__compile
- binary output folder for the compiler.\__package
- output folder for zip and NuGet packages.\__test
- test results folder.
Build Environment Variables
set FORCE_VERSION=1.2.3
IfFORCE_VERSION
environment variable is set with a semantic version number (eg:x.y.z
), the build tasks will use theFORCE_VERSION
to produce builds with the exact version number. Useful for testing out-of-band custom builds. However, it is not possible to reproduce exact binary equivalents of released NuGet packages because packages release on NuGet contain assemblies that are digitally signed with assembly signing enabled. The public does not have access to the signing key.
Rebundling Locales
Re-bundling the latest locale data from faker.js requires the following software installed:
Steps to re-bundle locale data from faker.js:
git clone https://github.com/bchavez/Bogus.git
cd Bogus
git submodule init
git submodule update
- Ensure NodeJS and
gulp
are properly installed. cd Source\Builder
npm install
to install required dev dependencies.npx gulp importLocales
to regenerate locales inSource\Bogus\data
.- Finally, run
build.cmd
.
License
Contributors
Created by Brian Chavez.
faker.js made possible by Matthew Bergman & Marak Squires.
A big thanks to GitHub and all contributors: