Faker C++

Generate fake (but realistic) data for testing and development

The goal of Faker C++ is to provide a library similar to Faker.js for C++ community. Faker C++ helps with the creation of realistic and customizable fake data for testing and development purposes within C++ applications.

To properly use Faker C++ you must first consume the Faker library (see Consuming Library with CMake). Once that is done, you need to include the proper header files depending on the module you wish to generate data from. The module header file names can be found in docs.

Below is an example of how to use Faker C++ in your code.

#include <iostream>

#include "faker-cxx/Date.h"
#include "faker-cxx/Internet.h"
#include "faker-cxx/Location.h"
#include "faker-cxx/String.h"

int main()
{
    const auto id = faker::String::uuid();
    const auto email = faker::Internet::email();
    const auto password = faker::Internet::password();
    const auto city = faker::Location::city();
    const auto streetAddress = faker::Location::streetAddress();

    std::cout << id << std::endl;               // 58018063-ce5a-4fa7-adfd-327eb2e2d9a5
    std::cout << email << std::endl;            // [email protected]
    std::cout << password << std::endl;         // @cWLwgM#Knalxeb
    std::cout << city << std::endl;             // Sayreville
    std::cout << streetAddress << std::endl;    // 1716 Harriet Alley

    return 0;
}

• 🛩 Airline - aircraft types, airlines, airports, flight numbers
• 🐼 Animal - animal types and species
• 📖 Book - book title, genre, author, publisher, ISBN
• 🎨 Color - color names, rgb, hex, hcl
• 🛒 Commerce - commerce department, product name, sku, price
• 🏢 Company - company name, type, industry, catch phrase, buzz phrase
• 🖥️ Computer - type, manufacturer, model, CPU info, GPU info
• 💾 Database - column names, column types, database engines
• ℹ️ Datatype - booleans
• 📅 Date - past, future dates
• 🏦 Finance - currency, IBAN, BIC, account name, account number, pin, credit card numbers
• 🍝 Food - food category, vegetables, fruits, meats, dishes
• 📁 Git - branch names, commit messages, commit hash
• 👨‍💻 Hacker - hacker words
• ✋ Helper - random element from container
• 🌐 Internet - emails, usernames, passwords, IP, HTTP
• 🖼️ Image - images urls, github avatar urls, image dimensions
• 🌍 Location - countries, cities, zip codes, street addresses
• 📚 Lorem - lorem words, sentences, paragraphs
• 🏥 Medicine - conditions, medical tests, specialties
• 🎥 Movie - actors, actresses, genres, movie titles
• 🎶 Music - artists, song names, genres
• 🔢 Number - random integers, floating point numbers
• 🧑 Person - first, last names, job titles, hobby, genders, sex, nationalitiy, language
• 📞 Phone - phone number, IMEI
• ⚽ Sport - sport names, athletes, events
• 🔢 String - uuids, alphanumeric, numeric, hexadecimal
• 💻 System - file paths, file extensions, file names, directories, semantic version
• 🎮 Video game - title, genre, platform, studio
• 🌤️ Weather - temperature, pressure, humidity, weather description
• 💬 Word - sample words, nouns, verbs

1. Add faker to git submodules (execute in project root):

   mkdir externals && cd externals
   git submodule add https://github.com/cieslarmichal/faker-cxx.git
   git submodule update --init --recursive
   

2. Link with library:

   set(BUILD_FAKER_TESTS OFF)
   
   add_subdirectory(externals/faker-cxx)
   
   add_executable(main Main.cpp)
   
   target_link_libraries(main faker-cxx)

Use one of these compilers when working with Faker C++.

• MSVC➚ version 143 or newer.
• GCC➚ version 13 or newer.
• Clang➚ version 16 or newer.
• Apple Clang➚ version 16 or newer.

If you have any confusion please refer to the respective guides.

• Clang++
• Apple Clang++
• G++
• MSVC

• GTest (set BUILD_CONFIG_CXX_TESTS=OFF CMake flag to disable this dependency)
• fmt (only for Apple Clang++ compiler)

We would love it if you contributed to Faker C++! 🚀

Before contributing please review our CONTRIBUTING guide.

Additionally, we encourage you to join our Discord Channel for contributors.