azure_data_cosmos_driver 0.2.0

Core implementation layer for Azure Cosmos DB - provides transport, routing, and protocol handling for cross-language SDK reuse
Documentation 
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

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

//! Environment variable handling for test framework.

use std::str::FromStr;

/// Environment variable name for Cosmos DB connection string.
pub const CONNECTION_STRING_ENV_VAR: &str = "AZURE_COSMOS_CONNECTION_STRING";

/// Environment variable for shared database name.
#[allow(dead_code)]
pub const DATABASE_NAME_ENV_VAR: &str = "DATABASE_NAME";

/// Environment variable to allow invalid certificates.
#[allow(dead_code)]
pub const ALLOW_INVALID_CERTS_ENV_VAR: &str = "AZURE_COSMOS_ALLOW_INVALID_CERT";

/// Environment variable for test mode.
pub const TEST_MODE_ENV_VAR: &str = "AZURE_COSMOS_TEST_MODE";

/// The well-known connection string for the Cosmos DB emulator.
///
/// This uses the default localhost endpoint and the well-known development key
/// that is used by all Cosmos DB emulator installations.
pub const EMULATOR_CONNECTION_STRING: &str = "AccountEndpoint=https://localhost:8081;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==;";

/// Test mode for Cosmos DB tests.
#[derive(PartialEq, Eq, Clone, Copy, Debug, Default)]
pub enum CosmosTestMode {
    /// Tests are enabled and will fail if the env vars are not set.
    Required,

    /// Tests are disabled and will not attempt to run.
    Skipped,

    /// Tests can run if the env vars are set, but will not fail if they are not.
    #[default]
    Allowed,
}

impl FromStr for CosmosTestMode {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "required" => Ok(CosmosTestMode::Required),
            "skipped" => Ok(CosmosTestMode::Skipped),
            "allowed" => Ok(CosmosTestMode::Allowed),
            _ => Err(()),
        }
    }
}

/// Gets the test mode from the environment.
pub fn get_test_mode() -> CosmosTestMode {
    std::env::var(TEST_MODE_ENV_VAR)
        .ok()
        .and_then(|s| s.parse().ok())
        .unwrap_or_default()
}

/// Returns true if the tests are running on Azure Pipelines.
pub fn is_azure_pipelines() -> bool {
    std::env::var("SYSTEM_TEAMPROJECTID").is_ok()
}