chore: standardize env var name to be MOMENTO_API_KEY

.github/workflows/cd.yml

@@ -46,8 +46,6 @@ jobs:
 #    needs: release
 #    env:
 #      MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
-#      # TODO: get rid of this once everything has been migrated to MOMENTO_API_KEY
-#      TEST_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
 #      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 #    steps:
 #      - uses: actions/checkout@v2

.github/workflows/ci.yaml

@@ -34,8 +34,6 @@ jobs:
     runs-on: macos-latest
     env:
       MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
-      # TODO: get rid of this once everything has been migrated to MOMENTO_API_KEY
-      TEST_AUTH_TOKEN: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
 
     steps:
       - uses: actions/checkout@v2

README.md

@@ -78,7 +78,7 @@ async fn demo_cache_usage() {
 
 ## Running Tests ⚡
 
-Doc and integration tests require an auth token for testing. Set the env var `TEST_AUTH_TOKEN` to
+Doc and integration tests require an auth token for testing. Set the env var `MOMENTO_API_KEY` to
 provide it.
 
 Running unit tests:
@@ -90,13 +90,13 @@ cargo test --lib
 Running doc tests:
 
 ```
-TEST_AUTH_TOKEN=<auth token> cargo test --doc
+MOMENTO_API_KEY=<auth token> cargo test --doc
 ```
 
 Running integration tests:
 
 ```
-TEST_AUTH_TOKEN=<auth token> cargo test --tests
+MOMENTO_API_KEY=<auth token> cargo test --tests
 ```
 
 ## Development 🔨

src/credential_provider.rs

@@ -76,9 +76,9 @@ impl CredentialProviderBuilder {
     /// ```
     /// # tokio_test::block_on(async {
     ///     use momento::CredentialProviderBuilder;
-    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///         .build()
-    ///         .expect("TEST_AUTH_TOKEN must be set");
+    ///         .expect("MOMENTO_API_KEY must be set");
     /// # })
     /// ```
     ///
@@ -122,10 +122,10 @@ impl CredentialProviderBuilder {
     /// ```
     /// # tokio_test::block_on(async {
     ///     use momento::CredentialProviderBuilder;
-    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///         .with_cache_endpoint("my_cache_endpoint.com".to_string())
     ///         .build()
-    ///         .expect("TEST_AUTH_TOKEN must be set");
+    ///         .expect("MOMENTO_API_KEY must be set");
     ///      assert_eq!("https://my_cache_endpoint.com", credential_provider.cache_endpoint);
     /// # })
     /// ```
@@ -144,10 +144,10 @@ impl CredentialProviderBuilder {
     /// ```
     /// # tokio_test::block_on(async {
     ///     use momento::CredentialProviderBuilder;
-    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///         .with_control_endpoint("my_control_endpoint.com".to_string())
     ///         .build()
-    ///         .expect("TEST_AUTH_TOKEN must be set");
+    ///         .expect("MOMENTO_API_KEY must be set");
     ///      assert_eq!("https://my_control_endpoint.com", credential_provider.control_endpoint);
     /// # })
     /// ```
@@ -166,10 +166,10 @@ impl CredentialProviderBuilder {
     /// ```
     /// # tokio_test::block_on(async {
     ///     use momento::CredentialProviderBuilder;
-    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///         .with_momento_endpoint("my_endpoint.com".to_string())
     ///         .build()
-    ///         .expect("TEST_AUTH_TOKEN must be set");
+    ///         .expect("MOMENTO_API_KEY must be set");
     ///      assert_eq!("https://cache.my_endpoint.com", credential_provider.cache_endpoint);
     ///      assert_eq!("https://control.my_endpoint.com", credential_provider.control_endpoint);
     /// # })

src/simple_cache_client.rs

@@ -169,9 +169,9 @@ impl SimpleCacheClientBuilder {
     /// # tokio_test::block_on(async {
     ///     use momento::{CredentialProviderBuilder, SimpleCacheClientBuilder};
     ///     use std::time::Duration;
-    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    ///     let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///         .build()
-    ///         .expect("TEST_AUTH_TOKEN must be set");
+    ///         .expect("MOMENTO_API_KEY must be set");
     ///     let momento = SimpleCacheClientBuilder::new(credential_provider, Duration::from_secs(30))
     ///         .expect("could not create a client")
     ///         .build();
@@ -284,9 +284,9 @@ impl SimpleCacheClient {
     /// use std::time::Duration;
     /// use momento::{CredentialProviderBuilder, SimpleCacheClientBuilder};
     ///
-    /// let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    /// let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///     .build()
-    ///     .expect("TEST_AUTH_TOKEN must be set");
+    ///     .expect("MOMENTO_API_KEY must be set");
     /// let cache_name = "rust-sdk-".to_string() + &Uuid::new_v4().to_string();
     /// let mut momento = SimpleCacheClientBuilder::new(credential_provider, Duration::from_secs(5))?
     ///     .build();
@@ -318,9 +318,9 @@ impl SimpleCacheClient {
     /// use std::time::Duration;
     /// use momento::{CredentialProviderBuilder, SimpleCacheClientBuilder};
     ///
-    /// let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    /// let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///     .build()
-    ///     .expect("TEST_AUTH_TOKEN must be set");
+    ///     .expect("MOMENTO_API_KEY must be set");
     /// let cache_name = "rust-sdk-".to_string() + &Uuid::new_v4().to_string();
     /// let mut momento = SimpleCacheClientBuilder::new(credential_provider, Duration::from_secs(5))?
     ///     .build();
@@ -424,9 +424,9 @@ impl SimpleCacheClient {
     /// use momento::{CredentialProviderBuilder, SimpleCacheClientBuilder};
     ///
     /// let ttl_minutes = 10;
-    /// let credential_provider = CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+    /// let credential_provider = CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
     ///     .build()
-    ///     .expect("TEST_AUTH_TOKEN must be set");
+    ///     .expect("MOMENTO_API_KEY must be set");
     /// let mut momento = SimpleCacheClientBuilder::new(credential_provider, Duration::from_secs(5))?
     ///     .build();
     ///

test-util/src/lib.rs

@@ -30,9 +30,9 @@ where
 
     let cache_name = "rust-sdk-".to_string() + &Uuid::new_v4().to_string();
     let credential_provider =
-        CredentialProviderBuilder::from_environment_variable("TEST_AUTH_TOKEN".to_string())
+        CredentialProviderBuilder::from_environment_variable("MOMENTO_API_KEY".to_string())
             .build()
-            .expect("TEST_AUTH_TOKEN must be set");
+            .expect("MOMENTO_API_KEY must be set");
 
     let mut client =
         SimpleCacheClientBuilder::new(credential_provider.clone(), Duration::from_secs(5))?.build();

tests/integration_test.rs

@@ -28,7 +28,7 @@ mod tests {
     }
 
     fn get_momento_instance() -> SimpleCacheClient {
-        let auth_token = env::var("TEST_AUTH_TOKEN").expect("env var TEST_AUTH_TOKEN must be set");
+        let auth_token = env::var("MOMENTO_API_KEY").expect("env var MOMENTO_API_KEY must be set");
         get_momento_instance_with_token(auth_token)
             .expect("failed to build an integration test client builder")
             .build()