README.md

fakedata_generator

A rust library to generate fake data

Table of contents

• Table of contents
• About
• Usage
• Generators
  • Generators without arguments
    • email
    • username
    • domain
    • http method
    • ipv4
    • gen_prime
    • enum
    • int
    • private ipv4
    • passwords
      • Without special chars
      • With special chars
  • Corpora generator
• Users
• Contributing
  • Where to start?
  • Tooling
• Code of Conduct
• License

About

⬆️ Back to Top

This library provides functions to generate random values ("fake data"). It is in its early stages and some values are not yet fully random. Basic documentation is provided below and on https://docs.rs/fakedata_generator/.

Usage

⬆️ Back to Top

Add the library as dependency to your Cargo.toml.

[dependencies]
fakedata_generator = "0.4"

Now the the library can be loaded with use fakedata_generator::*.

extern crate fakedata_generator;
use fakedata_generator::*;

fn main() {
    let random_word = gen_enum("some,random,words".to_string());
    println!("Random word is: {}", random_word); 
}

A full list of available generators and their function signature is shown below.

Generators

Generators without arguments

⬆️ Back to Top

email

Return a random e-Mail address which is a combination of the username and domain generator.

Function signature

gen_email() -> String

Example call

let email: String = gen_email();
// email = [email protected]

username

Return a random username.

Note: predefined list as of v0.2.

Function signature

gen_username() -> String

Example call

let user: String = gen_username();
// user = ahmadajmi

domain

Return a random domain name.

Note: Does not yet support all TDLs and true random host names - it's created by a predefined list.

Function signature

gen_domain() -> String

Example call

let domain: String = gen_domain();
// domain = "names.us"

http method

Return a random HTTP method from a defined list.

Possible values: "DELETE", "GET", "HEAD", "OPTION", "PATCH", "POST", "PUT"

Function signature

gen_http_method() -> String

Example call

let method: String = gen_http_method();
// method = "GET"

ipv4

Returns a random IP address. Generates four numbers in the range of 0 - 255 which are written out in the format {}.{}.{}.{}.

Function signature

gen_ipv4() -> String

Example call

let ip: String = gen_ipv4();
// ip = "168.11.40.75"

gen_prime

Returns one of the first 1000 prime numners, randomely.

Function signature

gen_prime() -> usize

Example call

let prime: usize = gen_prime();
// prime = 6323

Generators with arguments

⬆️ Back to Top

enum

Return random string from set of specified strings. Specify a comma separated list as argument.

Function signature

gen_enum(input: String) -> String

Example call

let word: String = gen_enum("hello,hola,hallo".to_string());
// word = "hola"

int

Return random integer in range. Must specify 1 or 2 numbers separated by comma. If 1 argument is specified it is handled as "highest" value and 0 is used as lowest value.

Function signature

gen_int(input: String) -> String

Example call

let num: String = gen_enum("1,100".to_string());
// num = "42"

private ipv4

Creates a private IPv4 address in one of these 3 ranges:

• 10.0.0.0 – 10.255.255.255
• 172.16.0.0 – 172.31.255.255
• 192.168.0.0 – 192.168.255.255

The input is the number of the first block and can be 10, 172, or 192. If an invalid value is specified it defaults to 10.

Function signature

gen_private_ip(input: usize) -> String

Example call

let private_ipv4: String = gen_private_ipv4(10);
// num = 10.64.197.255

passwords

Without special chars

Creates a random string.

The input is the number of characters the password should consist of.

Function signature

gen_password(input: usize) -> String

Example call

let pw: String = gen_password(32);
// pw = "bNNpAmShvQYbKbMdhByK17lqaFcgarrF"

With special chars

Creates a random string with special chars.

The input is the number of characters the password should consist of.

Function signature

gen_password_with_special_chars(input: usize) -> String

Example call

let pw: String = gen_password_with_special_chars(32);
// pw = "F=>:e+KX;Uu/Zg#i*MQN//6r%a^K?K°0"

Corpora generator

⬆️ Back to Top

gen_corpora_switch is deprecated and should not be used anymore.

Instead there's a new gen_switch function that gets its data in JSON format taken from the Corpora Project. A copy of the entire Corpora project is included in the data directory. Not all data sets are available as of now. See the src/corpora/data.rs file for all available sets.

Possible input values:

• cat
• dog
• horse
• dinosaur
• gemstone
• mood
• fabric
• tvshow

Each of these will return a random word from the list.

Function signature

gen_switch(input: String) -> String

Example call

let word: String = gen_switch("cat".to_string());
// word = "European Shorthair"

let fabric: String = gen_switch("fabric".to_string());
// word = "longcloth"

Users

⬆️ Back to Top

The following is a list of projects using fakedata_generator. Want to have your project added? Open a PR! 🧡

Name	Description	Repository
fakedata_server	A HTTP API providing random values based on fakedata_generator data.	View code
vector	vector is a high-performance observability data pipeline. They use fakedata_generator as part of their test setup	View code

Contributing

⬆️ Back to Top

We love and welcome every form of contribution.

Where to start?

Here are some good places to start:

• Issues with label Good first issue
• Issues with label Documentation
• Providing example implementations or usage demos

Tooling

• mktoc is used for table of content generation in the README.md
• grcov is used to generate the coverage badge
  • this is currently done by hand and not by CI, run helpers/coverage.sh to update the badge

Code of Conduct

⬆️ Back to Top

You are expected to follow our code of conduct when interacting with the project via issues, pull requests or in any other form. Many thanks to the awesome contributor covenant initiative!

License

⬆️ Back to Top

MIT License Copyright (c) 2019 Kevin Gimbel

Special Thanks to the Rust Community, Rust Language Maintainers, and JetBrains for IntelliJ IDEA. See NOTICE for full list.