lib.rs - source
Description: Source of the Rust file `src/lib.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332

    #![deny(
        absolute_paths_not_starting_with_crate,
        ambiguous_associated_items,
        anonymous_parameters,
        arithmetic_overflow,
        array_into_iter,
        asm_sub_register,
        bindings_with_variant_name,
        broken_intra_doc_links,
        cenum_impl_drop_cast,
        clashing_extern_declarations,
        coherence_leak_check,
        conflicting_repr_hints,
        confusable_idents,
        const_err,
        const_evaluatable_unchecked,
        const_item_mutation,
        dead_code,
        deprecated,
        deprecated_in_future,
        drop_bounds,
        ellipsis_inclusive_range_patterns,
        explicit_outlives_requirements,
        exported_private_dependencies,
        function_item_references,
        ill_formed_attribute_input,
        illegal_floating_point_literal_pattern,
        improper_ctypes,
        improper_ctypes_definitions,
        incomplete_features,
        incomplete_include,
        indirect_structural_match,
        inline_no_sanitize,
        invalid_codeblock_attributes,
        invalid_type_param_default,
        invalid_value,
        irrefutable_let_patterns,
        keyword_idents,
        late_bound_lifetime_arguments,
        macro_expanded_macro_exports_accessed_by_absolute_paths,
        meta_variable_misuse,
        missing_copy_implementations,
        missing_crate_level_docs,
        missing_docs,
        mixed_script_confusables,
        mutable_borrow_reservation_conflict,
        mutable_transmutes,
        no_mangle_const_items,
        no_mangle_generic_items,
        non_ascii_idents,
        non_camel_case_types,
        non_shorthand_field_patterns,
        non_snake_case,
        non_upper_case_globals,
        nontrivial_structural_match,
        order_dependent_trait_objects,
        overflowing_literals,
        overlapping_patterns,
        path_statements,
        patterns_in_fns_without_body,
        pointer_structural_match,
        private_doc_tests,
        private_in_public,
        proc_macro_derive_resolution_fallback,
        pub_use_of_private_extern_crate,
        redundant_semicolons,
        safe_packed_borrows,
        soft_unstable,
        stable_features,
        temporary_cstring_as_ptr,
        trivial_bounds,
        trivial_casts,
        trivial_numeric_casts,
        type_alias_bounds,
        tyvar_behind_raw_pointer,
        unaligned_references,
        uncommon_codepoints,
        unconditional_panic,
        unconditional_recursion,
        uninhabited_static,
        unknown_crate_types,
        unnameable_test_items,
        unreachable_code,
        unreachable_patterns,
        unreachable_pub,
        unsafe_code,
        unstable_features,
        unstable_name_collisions,
        unused_allocation,
        unused_assignments,
        unused_attributes,
        unused_braces,
        unused_comparisons,
        unused_crate_dependencies,
        unused_doc_comments,
        unused_extern_crates,
        unused_features,
        unused_import_braces,
        unused_imports,
        unused_labels,
        unused_lifetimes,
        unused_macros,
        unused_must_use,
        unused_mut,
        unused_parens,
        unused_qualifications,
        unused_unsafe,
        unused_variables,
        where_clauses_object_safety,
        while_true
    )]
    #![warn(macro_use_extern_crate, unknown_lints)]
    #![allow(
        bare_trait_objects,
        box_pointers,
        elided_lifetimes_in_paths,
        invalid_html_tags,
        missing_doc_code_examples,
        missing_debug_implementations,
        single_use_lifetimes,
        unused_results,
        variant_size_differences,
        warnings,
        renamed_and_removed_lints
    )]

    //! # ci_info
    //!
    //! Provides current CI environment information.
    //!
    //! This library main goal is to provide development/build tools such as [cargo-make](https://sagiegurari.github.io/cargo-make/) the needed information on the current CI environment.<br>
    //! The code is based on the [ci-info](https://github.com/watson/ci-info) npm module.
    //!
    //! # Examples
    //!
    //! ## Get CI environment information
    //!
    //! ```
    //! fn main() {
    //!     // Just check if a CI environment is detected.
    //!     let ci = ci_info::is_ci();
    //!     println!("Is CI: {}", ci);
    //!
    //!     // Get CI environment information
    //!     let info = ci_info::get();
    //!     println!("Is CI: {}", info.ci);
    //!     if let Some(vendor) = info.vendor {
    //!         println!("Vendor: {:#?}", vendor);
    //!         println!("Name: {:#?}", info.name.unwrap());
    //!     }
    //!     if let Some(pr) = info.pr {
    //!         println!("Is PR: {:#?}", pr);
    //!     }
    //!     if let Some(branch_name) = info.branch_name {
    //!         println!("Branch Name: {:#?}", branch_name);
    //!     }
    //! }
    //! ```
    //!
    //! ## Check if a CI environment is detected
    //!
    //! ```
    //! fn main() {
    //!     let ci = ci_info::is_ci();
    //!
    //!     println!("Is CI: {}", ci);
    //! }
    //! ```
    //!
    //! ## Mocking CI environment
    //!
    //! ```
    //! use ci_info::types::{CiInfo, Vendor};
    //!
    //! fn main() {
    //!     // create the CI info manually
    //!     let mut mock_info = CiInfo::new();
    //!     mock_info.vendor = Some(Vendor::TravisCI);
    //!     mock_info.ci = true;
    //!     mock_info.pr = Some(true);
    //!     mock_info.branch_name = Some("dev_branch".to_string());
    //!
    //!     // mock environment
    //!     ci_info::mock_ci(&mock_info);
    //!
    //!     let info = ci_info::get();
    //!
    //!     assert!(info.ci);
    //!     assert!(info.pr.unwrap());
    //!     assert_eq!(info.vendor.unwrap(), Vendor::TravisCI);
    //!     assert_eq!(info.name.unwrap(), "Travis CI");
    //!     assert_eq!(info.branch_name.unwrap(), "dev_branch");
    //!
    //!     // clear CI environment
    //!     mock_info = CiInfo::new();
    //!     ci_info::mock_ci(&mock_info);
    //!
    //!     let info = ci_info::get();
    //!
    //!     assert!(!info.ci);
    //! }
    //! ```
    //!
    //! # Installation
    //! In order to use this library, just add it as a dependency:
    //!
    //! ```ini
    //! [dependencies]
    //! ci_info = "*"
    //! ```
    //!
    //! There is optional `serde` support that can be enabled via the `serde-1` feature:
    //!
    //! ```ini
    //! [dependencies]
    //! ci_info = { version = "*", features = ["serde-1"] }
    //! ```
    //!
    //! # Contributing
    //! See [contributing guide](https://github.com/sagiegurari/ci_info/blob/master/.github/CONTRIBUTING.md)
    //!
    //! # License
    //! Developed by Sagie Gur-Ari and licensed under the
    //! [Apache 2](https://github.com/sagiegurari/ci_info/blob/master/LICENSE) open source license.
    //!

    #[cfg(feature = "serde-1")]
    #[macro_use]
    extern crate serde_derive;
    #[cfg(test)]
    #[path = "./lib_test.rs"]
    mod lib_test;
    #[cfg(test)]
    #[path = "./test_env.rs"]
    mod test_env;
    #[cfg(test)]
    #[path = "./vendors_test.rs"]
    mod vendors_test;

    #[cfg(doctest)]
    doc_comment::doctest!("../README.md");

    mod ci;
    mod config;
    mod mock;
    pub mod types;

    use crate::types::CiInfo;

    /// Loads and returns the CI info of the current environment.
    ///
    /// # Example
    ///
    /// ```
    /// fn main() {
    ///     // Just check if a CI environment is detected.
    ///     let ci = ci_info::is_ci();
    ///     println!("Is CI: {}", ci);
    ///
    ///     // Get CI environment information
    ///     let info = ci_info::get();
    ///     println!("Is CI: {}", info.ci);
    ///     if info.vendor.is_some() {
    ///         println!("Vendor: {:#?}", info.vendor.unwrap());
    ///         println!("Name: {:#?}", info.name.unwrap());
    ///     }
    ///     if info.pr.is_some() {
    ///         println!("Is PR: {:#?}", info.pr.unwrap());
    ///     }
    ///     if info.branch_name.is_some() {
    ///         println!("Branch Name: {:#?}", info.branch_name.unwrap());
    ///     }
    /// }
    /// ```
    pub fn get() -> CiInfo {
        ci::get()
    }

    /// Returns true if a CI environment is detected.
    ///
    /// # Example
    ///
    /// ```
    /// fn main() {
    ///     let ci = ci_info::is_ci();
    ///
    ///     println!("Is CI: {}", ci);
    /// }
    /// ```
    pub fn is_ci() -> bool {
        ci::is_ci()
    }

    /// This function will modify the current environment variables to mock the
    /// requested CI vendor.
    ///
    /// # Example
    ///
    /// ```
    /// use ci_info::types::{CiInfo, Vendor};
    ///
    /// fn main() {
    ///     // create the CI info manually
    ///     let mut mock_info = CiInfo::new();
    ///     mock_info.vendor = Some(Vendor::TravisCI);
    ///     mock_info.ci = true;
    ///     mock_info.pr = Some(true);
    ///     mock_info.branch_name = Some("dev_branch".to_string());
    ///
    ///     // mock environment
    ///     ci_info::mock_ci(&mock_info);
    ///
    ///     let info = ci_info::get();
    ///
    ///     assert!(info.ci);
    ///     assert!(info.pr.unwrap());
    ///     assert_eq!(info.vendor.unwrap(), Vendor::TravisCI);
    ///     assert_eq!(info.name.unwrap(), "Travis CI");
    ///     assert_eq!(info.branch_name.unwrap(), "dev_branch");
    ///
    ///     // clear CI environment
    ///     mock_info = CiInfo::new();
    ///     ci_info::mock_ci(&mock_info);
    ///
    ///     let info = ci_info::get();
    ///
    ///     assert!(!info.ci);
    /// }
    /// ```
    pub fn mock_ci(info: &CiInfo) {
        mock::mock_ci_info(info);
    }