2022-12-15 22:58:21 +01:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charset = "utf-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < meta name = "generator" content = "rustdoc" > < meta name = "description" content = "Source of the Rust file `orca/src/./opt.rs`." > < meta name = "keywords" content = "rust, rustlang, rust-lang" > < title > opt.rs - source< / title > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceSerif4-Regular.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../FiraSans-Regular.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../FiraSans-Medium.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceCodePro-Regular.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceSerif4-Bold.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceCodePro-Semibold.ttf.woff2" > < link rel = "stylesheet" href = "../../normalize.css" > < link rel = "stylesheet" href = "../../rustdoc.css" id = "mainThemeStyle" > < link rel = "stylesheet" href = "../../ayu.css" disabled > < link rel = "stylesheet" href = "../../dark.css" disabled > < link rel = "stylesheet" href = "../../light.css" id = "themeStyle" > < script id = "default-settings" > < / script > < script src = "../../storage.js" > < / script > < script defer src = "../../source-script.js" > < / script > < script defer src = "../../source-files.js" > < / script > < script defer src = "../../main.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../noscript.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../../favicon-16x16.png" > < link rel = "alternate icon" type = "image/png" href = "../../favicon-32x32.png" > < link rel = "icon" type = "image/svg+xml" href = "../../favicon.svg" > < / head > < body class = "rustdoc source" > <!-- [if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif] --> < nav class = "sidebar" > < / nav > < main > < div class = "width-limiter" > < nav class = "sub" > < a class = "sub-logo-container" href = "../../orca/index.html" > < img class = "rust-logo" src = "../../rust-logo.svg" alt = "logo" > < / a > < form class = "search-form" > < span > < / span > < input class = "search-input" name = "search" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < div id = "help-button" title = "help" tabindex = "-1" > < a href = "../../help.html" > ?< / a > < / div > < div id = "settings-menu" tabindex = "-1" > < a href = "../../settings.html" title = "settings" > < img width = "22" height = "22" alt = "Change settings" src = "../../wheel.svg" > < / a > < / div > < / form > < / nav > < section id = "main-content" class = "content" > < div class = "example-wrap" > < pre class = "src-line-numbers" > < span id = "1" > 1< / span >
2022-10-07 11:23:12 +02:00
< span id = "2" > 2< / span >
< span id = "3" > 3< / span >
< span id = "4" > 4< / span >
< span id = "5" > 5< / span >
< span id = "6" > 6< / span >
< span id = "7" > 7< / span >
< span id = "8" > 8< / span >
< span id = "9" > 9< / span >
< span id = "10" > 10< / span >
< span id = "11" > 11< / span >
< span id = "12" > 12< / span >
< span id = "13" > 13< / span >
< span id = "14" > 14< / span >
< span id = "15" > 15< / span >
< span id = "16" > 16< / span >
< span id = "17" > 17< / span >
< span id = "18" > 18< / span >
< span id = "19" > 19< / span >
< span id = "20" > 20< / span >
< span id = "21" > 21< / span >
< span id = "22" > 22< / span >
< span id = "23" > 23< / span >
< span id = "24" > 24< / span >
< span id = "25" > 25< / span >
< span id = "26" > 26< / span >
< span id = "27" > 27< / span >
< span id = "28" > 28< / span >
< span id = "29" > 29< / span >
< span id = "30" > 30< / span >
< span id = "31" > 31< / span >
< span id = "32" > 32< / span >
< span id = "33" > 33< / span >
< span id = "34" > 34< / span >
< span id = "35" > 35< / span >
< span id = "36" > 36< / span >
< span id = "37" > 37< / span >
< span id = "38" > 38< / span >
< span id = "39" > 39< / span >
< span id = "40" > 40< / span >
< span id = "41" > 41< / span >
< span id = "42" > 42< / span >
< span id = "43" > 43< / span >
< span id = "44" > 44< / span >
< span id = "45" > 45< / span >
< span id = "46" > 46< / span >
< span id = "47" > 47< / span >
< span id = "48" > 48< / span >
< span id = "49" > 49< / span >
< span id = "50" > 50< / span >
< span id = "51" > 51< / span >
< span id = "52" > 52< / span >
< span id = "53" > 53< / span >
< span id = "54" > 54< / span >
< span id = "55" > 55< / span >
< span id = "56" > 56< / span >
< span id = "57" > 57< / span >
< span id = "58" > 58< / span >
< span id = "59" > 59< / span >
< span id = "60" > 60< / span >
< span id = "61" > 61< / span >
< span id = "62" > 62< / span >
< span id = "63" > 63< / span >
< span id = "64" > 64< / span >
< span id = "65" > 65< / span >
< span id = "66" > 66< / span >
< span id = "67" > 67< / span >
< span id = "68" > 68< / span >
< span id = "69" > 69< / span >
< span id = "70" > 70< / span >
< span id = "71" > 71< / span >
< span id = "72" > 72< / span >
< span id = "73" > 73< / span >
< span id = "74" > 74< / span >
< span id = "75" > 75< / span >
< span id = "76" > 76< / span >
< span id = "77" > 77< / span >
< span id = "78" > 78< / span >
< span id = "79" > 79< / span >
< span id = "80" > 80< / span >
< span id = "81" > 81< / span >
< span id = "82" > 82< / span >
< span id = "83" > 83< / span >
< span id = "84" > 84< / span >
< span id = "85" > 85< / span >
< span id = "86" > 86< / span >
< span id = "87" > 87< / span >
< span id = "88" > 88< / span >
< span id = "89" > 89< / span >
< span id = "90" > 90< / span >
< span id = "91" > 91< / span >
< span id = "92" > 92< / span >
< span id = "93" > 93< / span >
< span id = "94" > 94< / span >
< span id = "95" > 95< / span >
< span id = "96" > 96< / span >
< span id = "97" > 97< / span >
< span id = "98" > 98< / span >
< span id = "99" > 99< / span >
< span id = "100" > 100< / span >
< span id = "101" > 101< / span >
< span id = "102" > 102< / span >
< span id = "103" > 103< / span >
< span id = "104" > 104< / span >
< span id = "105" > 105< / span >
< span id = "106" > 106< / span >
< span id = "107" > 107< / span >
< span id = "108" > 108< / span >
< span id = "109" > 109< / span >
< span id = "110" > 110< / span >
< span id = "111" > 111< / span >
< span id = "112" > 112< / span >
< span id = "113" > 113< / span >
< span id = "114" > 114< / span >
< span id = "115" > 115< / span >
< span id = "116" > 116< / span >
< span id = "117" > 117< / span >
< span id = "118" > 118< / span >
< span id = "119" > 119< / span >
< span id = "120" > 120< / span >
< span id = "121" > 121< / span >
< span id = "122" > 122< / span >
< span id = "123" > 123< / span >
< span id = "124" > 124< / span >
< span id = "125" > 125< / span >
< span id = "126" > 126< / span >
< span id = "127" > 127< / span >
< span id = "128" > 128< / span >
< span id = "129" > 129< / span >
< span id = "130" > 130< / span >
< span id = "131" > 131< / span >
< span id = "132" > 132< / span >
< span id = "133" > 133< / span >
< span id = "134" > 134< / span >
2022-11-04 01:07:22 +01:00
< / pre > < pre class = "rust" > < code > < span class = "kw" > use < / span > std::str::FromStr;
2022-10-07 11:23:12 +02:00
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Parser)]
< / span > < span class = "kw" > struct < / span > CommonOpt {
< span class = "attribute" > #[clap(short, long)]
< / span > < span class = "doccomment" > /// Enable debug logging
< / span > < span class = "kw" > pub < / span > debug: bool,
2022-10-07 11:23:12 +02:00
}
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Parser)]
< / span > < span class = "kw" > struct < / span > PreProcOpt {
< span class = "attribute" > #[clap(flatten)]
< / span > < span class = "kw" > pub < / span > copt: CommonOpt,
< span class = "attribute" > #[clap(parse(from_os_str), short, long = < span class = "string" > " input" < / span > )]
< / span > < span class = "doccomment" > /// Path to unprocessed data in json format.
< / span > < span class = "kw" > pub < / span > input_path: PathBuf,
< span class = "attribute" > #[clap(parse(from_os_str), short, long = < span class = "string" > " output" < / span > )]
< / span > < span class = "doccomment" > /// Path to write the processed output.
< / span > < span class = "kw" > pub < / span > output_path: PathBuf,
2022-10-07 11:23:12 +02:00
}
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Parser)]
< / span > < span class = "kw" > struct < / span > SetupOpt {
< span class = "attribute" > #[clap(flatten)]
< / span > < span class = "kw" > pub < / span > copt: CommonOpt,
< span class = "attribute" > #[clap(name = < span class = "string" > " target" < / span > )]
< / span > < span class = "doccomment" > /// Which service to target during this operation.
/// Valid values are " ds" or " kanidm"
< / span > < span class = "kw" > pub < / span > target: TargetOpt,
< span class = "attribute" > #[clap(parse(from_os_str), short, long = < span class = "string" > " profile" < / span > )]
< / span > < span class = "doccomment" > /// Path to the test profile.
< / span > < span class = "kw" > pub < / span > profile_path: PathBuf,
2022-10-07 11:23:12 +02:00
}
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Parser)]
< / span > < span class = "kw" > struct < / span > RunOpt {
< span class = "attribute" > #[clap(flatten)]
< / span > < span class = "kw" > pub < / span > copt: CommonOpt,
< span class = "attribute" > #[clap(name = < span class = "string" > " target" < / span > )]
< / span > < span class = "doccomment" > /// Which service to target during this operation.
/// Valid values are " ds" or " kanidm"
< / span > < span class = "kw" > pub < / span > target: TargetOpt,
< span class = "attribute" > #[clap(name = < span class = "string" > " test_type" < / span > )]
< / span > < span class = "doccomment" > /// Which type of test to run against this system
< / span > < span class = "kw" > pub < / span > test_type: TestTypeOpt,
< span class = "attribute" > #[clap(parse(from_os_str), short, long = < span class = "string" > " profile" < / span > )]
< / span > < span class = "doccomment" > /// Path to the test profile.
< / span > < span class = "kw" > pub < / span > profile_path: PathBuf,
2022-10-07 11:23:12 +02:00
}
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Subcommand)]
< / span > < span class = "kw" > pub< / span > (< span class = "kw" > crate< / span > ) < span class = "kw" > enum < / span > TargetOpt {
< span class = "attribute" > #[clap(name = < span class = "string" > " ds" < / span > )]
< / span > < span class = "doccomment" > /// Run against the ldap/ds profile
< / span > Ds,
< span class = "attribute" > #[clap(name = < span class = "string" > " kanidm" < / span > )]
< / span > < span class = "doccomment" > /// Run against the kanidm http profile
< / span > Kanidm,
< span class = "attribute" > #[clap(name = < span class = "string" > " kanidm_ldap" < / span > )]
< / span > < span class = "doccomment" > /// Run against the kanidm ldap profile
< / span > KanidmLdap,
2022-10-07 11:23:12 +02:00
}
2022-11-04 01:07:22 +01:00
< span class = "kw" > impl < / span > FromStr < span class = "kw" > for < / span > TargetOpt {
< span class = "kw" > type < / span > < span class = "prelude-val" > Err < / span > = < span class = "kw-2" > & < / span > < span class = "lifetime" > ' static < / span > str;
2022-10-07 11:23:12 +02:00
2022-11-04 01:07:22 +01:00
< span class = "kw" > fn < / span > from_str(s: < span class = "kw-2" > & < / span > str) -> < span class = "prelude-ty" > Result< / span > < < span class = "self" > Self< / span > , < span class = "self" > Self< / span > ::Err> {
< span class = "kw" > match < / span > s {
< span class = "string" > " ds" < / span > => < span class = "prelude-val" > Ok< / span > (TargetOpt::Ds),
< span class = "string" > " kanidm" < / span > => < span class = "prelude-val" > Ok< / span > (TargetOpt::Kanidm),
< span class = "string" > " kanidm_ldap" < / span > => < span class = "prelude-val" > Ok< / span > (TargetOpt::KanidmLdap),
< span class = "kw" > _ < / span > => < span class = "prelude-val" > Err< / span > (< span class = "string" > " Invalid target type. Must be ds, kanidm, or kanidm_ldap" < / span > ),
2022-10-07 11:23:12 +02:00
}
}
}
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Subcommand)]
< / span > < span class = "kw" > pub< / span > (< span class = "kw" > crate< / span > ) < span class = "kw" > enum < / span > TestTypeOpt {
< span class = "attribute" > #[clap(name = < span class = "string" > " search-basic" < / span > )]
< / span > < span class = "doccomment" > /// Perform a basic search-only test
< / span > SearchBasic,
2022-10-07 11:23:12 +02:00
}
2022-11-04 01:07:22 +01:00
< span class = "kw" > impl < / span > FromStr < span class = "kw" > for < / span > TestTypeOpt {
< span class = "kw" > type < / span > < span class = "prelude-val" > Err < / span > = < span class = "kw-2" > & < / span > < span class = "lifetime" > ' static < / span > str;
2022-10-07 11:23:12 +02:00
2022-11-04 01:07:22 +01:00
< span class = "kw" > fn < / span > from_str(s: < span class = "kw-2" > & < / span > str) -> < span class = "prelude-ty" > Result< / span > < < span class = "self" > Self< / span > , < span class = "self" > Self< / span > ::Err> {
< span class = "kw" > match < / span > s {
< span class = "string" > " search-basic" < / span > => < span class = "prelude-val" > Ok< / span > (TestTypeOpt::SearchBasic),
< span class = "kw" > _ < / span > => < span class = "prelude-val" > Err< / span > (< span class = "string" > " Invalid test type." < / span > ),
2022-10-07 11:23:12 +02:00
}
}
}
2022-11-04 01:07:22 +01:00
< span class = "kw" > impl < / span > std::fmt::Display < span class = "kw" > for < / span > TestTypeOpt {
< span class = "kw" > fn < / span > fmt(< span class = "kw-2" > & < / span > < span class = "self" > self< / span > , f: < span class = "kw-2" > & mut < / span > std::fmt::Formatter< < span class = "lifetime" > ' _< / span > > ) -> std::fmt::Result {
< span class = "kw" > match < / span > < span class = "kw-2" > & < / span > < span class = "self" > self < / span > {
TestTypeOpt::SearchBasic => < span class = "macro" > write!< / span > (f, < span class = "string" > " search-basic" < / span > ),
2022-10-07 11:23:12 +02:00
}
}
}
2022-11-04 01:07:22 +01:00
< span class = "attribute" > #[derive(Debug, Parser)]
#[clap(
name = < span class = "string" > " orca" < / span > ,
about = < span class = "string" > " Orca Load Testing Utility
2022-10-07 11:23:12 +02:00
Orca works in a few steps.
1. Create an orca config which defines the targets you want to be able to setup and load test. See example_profiles/small/orca.toml
2. (Optional) preprocess an anonymised 389-ds access log (created from an external tool) into an orca data set.
3. ' orca setup' the kanidm/389-ds instance from the orca data set. You can see an example of this in example_profiles/small/data.json. This will reset the database, and add tons of entries etc. For example:
orca setup kanidm -p ./example_profiles/small/orca.toml
4. ' orca run' one of the metrics, based on that data set. For example:
orca run -p example_profiles/small/orca.toml kanidm search-basic
2022-11-04 01:07:22 +01:00
"
< / span > )]
< / span > < span class = "kw" > enum < / span > OrcaOpt {
< span class = "attribute" > #[clap(name = < span class = "string" > " preprocess" < / span > )]
< / span > < span class = "doccomment" > /// Preprocess a dataset that can be used for testing
< / span > PreProc(PreProcOpt),
< span class = "attribute" > #[clap(name = < span class = "string" > " setup" < / span > )]
< / span > < span class = "doccomment" > /// Setup a server as defined by a test profile
< / span > Setup(SetupOpt),
< span class = "attribute" > #[clap(name = < span class = "string" > " run" < / span > )]
< / span > < span class = "doccomment" > /// Run the load test as defined by the test profile
< / span > Run(RunOpt),
2022-10-07 11:23:12 +02:00
}
< / code > < / pre > < / div >
2022-12-15 22:58:21 +01:00
< / section > < / div > < / main > < div id = "rustdoc-vars" data-root-path = "../../" data-current-crate = "orca" data-themes = "ayu,dark,light" data-resource-suffix = "" data-rustdoc-version = "1.66.0 (69f9c33d7 2022-12-12)" > < / div > < / body > < / html >
