refactor(api): [#197] make Axum implementation the default one

torrust · Jun 20, 2023 · 6fc6872 · 6fc6872
1 parent a662f9c
commit 6fc6872
Show file tree

Hide file tree

Showing 10 changed files with 317 additions and 275 deletions.
diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -32,4 +32,4 @@ jobs:
       - name: E2E Tests
         run: ./docker/bin/run-e2e-tests.sh
         env:
-          TORRUST_IDX_BACK_E2E_EXCLUDE_AXUM_IMPL: "true"
+          TORRUST_IDX_BACK_E2E_EXCLUDE_ACTIX_WEB_IMPL: "true"
diff --git a/src/bin/main.rs b/src/bin/main.rs
@@ -6,11 +6,7 @@ use torrust_index_backend::web::api::Implementation;
 async fn main() -> Result<(), std::io::Error> {
     let configuration = init_configuration().await;
 
-    // todo: we are migrating from actix-web to axum, so we need to keep both
-    // implementations for a while. For production we only use ActixWeb.
-    // Once the Axum implementation is finished and stable, we can switch to it
-    // and remove the ActixWeb implementation.
-    let api_implementation = Implementation::ActixWeb;
+    let api_implementation = Implementation::Axum;
 
     let app = app::run(configuration, &api_implementation).await;
 

diff --git a/tests/e2e/config.rs b/tests/e2e/config.rs
@@ -14,8 +14,8 @@ pub const ENV_VAR_E2E_SHARED: &str = "TORRUST_IDX_BACK_E2E_SHARED";
 /// The whole `config.toml` file content. It has priority over the config file.
 pub const ENV_VAR_E2E_CONFIG: &str = "TORRUST_IDX_BACK_E2E_CONFIG";
 
-/// If present, E2E tests for new Axum implementation will not be executed
-pub const ENV_VAR_E2E_EXCLUDE_AXUM_IMPL: &str = "TORRUST_IDX_BACK_E2E_EXCLUDE_AXUM_IMPL";
+/// If present, E2E tests for new `ActixWeb` implementation will not be executed
+pub const ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL: &str = "TORRUST_IDX_BACK_E2E_EXCLUDE_ACTIX_WEB_IMPL";
 
 // Default values
 

diff --git a/tests/e2e/contexts/about/contract.rs b/tests/e2e/contexts/about/contract.rs
@@ -1,14 +1,23 @@
 //! API contract for `about` context.
+use std::env;
+
 use torrust_index_backend::web::api;
 
 use crate::common::asserts::{assert_response_title, assert_text_ok};
 use crate::common::client::Client;
+use crate::e2e::config::ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL;
 use crate::e2e::environment::TestEnv;
 
 #[tokio::test]
 async fn it_should_load_the_about_page_with_information_about_the_api() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     let response = client.about().await;
@@ -21,6 +30,12 @@ async fn it_should_load_the_about_page_with_information_about_the_api() {
 async fn it_should_load_the_license_page_at_the_api_entrypoint() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     let response = client.license().await;

diff --git a/tests/e2e/contexts/category/contract.rs b/tests/e2e/contexts/category/contract.rs
@@ -1,11 +1,14 @@
 //! API contract for `category` context.
+use std::env;
+
 use torrust_index_backend::web::api;
 
 use crate::common::asserts::assert_json_ok_response;
 use crate::common::client::Client;
 use crate::common::contexts::category::fixtures::random_category_name;
 use crate::common::contexts::category::forms::{AddCategoryForm, DeleteCategoryForm};
 use crate::common::contexts::category::responses::{AddedCategoryResponse, ListResponse};
+use crate::e2e::config::ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL;
 use crate::e2e::contexts::category::steps::{add_category, add_random_category};
 use crate::e2e::contexts::user::steps::{new_logged_in_admin, new_logged_in_user};
 use crate::e2e::environment::TestEnv;
@@ -14,6 +17,12 @@ use crate::e2e::environment::TestEnv;
 async fn it_should_return_an_empty_category_list_when_there_are_no_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     let response = client.get_categories().await;
@@ -25,6 +34,12 @@ async fn it_should_return_an_empty_category_list_when_there_are_no_categories()
 async fn it_should_return_a_category_list() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     add_random_category(&env).await;
@@ -47,6 +62,12 @@ async fn it_should_return_a_category_list() {
 async fn it_should_not_allow_adding_a_new_category_to_unauthenticated_users() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     let response = client
@@ -64,6 +85,11 @@ async fn it_should_not_allow_adding_a_new_category_to_non_admins() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
 
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let logged_non_admin = new_logged_in_user(&env).await;
 
     let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_non_admin.token);
@@ -83,6 +109,11 @@ async fn it_should_allow_admins_to_add_new_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
 
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let logged_in_admin = new_logged_in_admin(&env).await;
     let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_in_admin.token);
 
@@ -111,6 +142,11 @@ async fn it_should_allow_adding_empty_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
 
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     if env.is_shared() {
         // This test cannot be run in a shared test env because it will fail
         // when the empty category already exits
@@ -144,6 +180,11 @@ async fn it_should_not_allow_adding_duplicated_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
 
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let added_category_name = add_random_category(&env).await;
 
     // Try to add the same category again
@@ -156,6 +197,11 @@ async fn it_should_allow_admins_to_delete_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
 
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let logged_in_admin = new_logged_in_admin(&env).await;
     let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_in_admin.token);
 
@@ -182,6 +228,11 @@ async fn it_should_not_allow_non_admins_to_delete_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
 
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let added_category_name = add_random_category(&env).await;
 
     let logged_in_non_admin = new_logged_in_user(&env).await;
@@ -201,6 +252,12 @@ async fn it_should_not_allow_non_admins_to_delete_categories() {
 async fn it_should_not_allow_guests_to_delete_categories() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     let added_category_name = add_random_category(&env).await;
@@ -216,7 +273,6 @@ async fn it_should_not_allow_guests_to_delete_categories() {
 }
 
 mod with_axum_implementation {
-    use std::env;
 
     use torrust_index_backend::web::api;
 
@@ -226,7 +282,6 @@ mod with_axum_implementation {
     use crate::common::contexts::category::fixtures::random_category_name;
     use crate::common::contexts::category::forms::{AddCategoryForm, DeleteCategoryForm};
     use crate::common::contexts::category::responses::ListResponse;
-    use crate::e2e::config::ENV_VAR_E2E_EXCLUDE_AXUM_IMPL;
     use crate::e2e::contexts::category::steps::{add_category, add_random_category};
     use crate::e2e::contexts::user::steps::{new_logged_in_admin, new_logged_in_user};
     use crate::e2e::environment::TestEnv;
@@ -248,11 +303,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
         add_random_category(&env).await;
@@ -276,11 +326,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
         let response = client
@@ -298,11 +343,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let logged_non_admin = new_logged_in_user(&env).await;
 
         let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_non_admin.token);
@@ -322,11 +362,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let logged_in_admin = new_logged_in_admin(&env).await;
         let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_in_admin.token);
 
@@ -356,11 +391,6 @@ mod with_axum_implementation {
             return;
         }
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let logged_in_admin = new_logged_in_admin(&env).await;
         let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_in_admin.token);
 
@@ -381,11 +411,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let added_category_name = add_random_category(&env).await;
 
         // Try to add the same category again
@@ -399,11 +424,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let logged_in_admin = new_logged_in_admin(&env).await;
         let client = Client::authenticated(&env.server_socket_addr().unwrap(), &logged_in_admin.token);
 
@@ -424,11 +444,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let added_category_name = add_random_category(&env).await;
 
         let logged_in_non_admin = new_logged_in_user(&env).await;
@@ -449,11 +464,6 @@ mod with_axum_implementation {
         let mut env = TestEnv::new();
         env.start(api::Implementation::Axum).await;
 
-        if env::var(ENV_VAR_E2E_EXCLUDE_AXUM_IMPL).is_ok() {
-            println!("Skipped");
-            return;
-        }
-
         let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
         let added_category_name = add_random_category(&env).await;

diff --git a/tests/e2e/contexts/root/contract.rs b/tests/e2e/contexts/root/contract.rs
@@ -1,14 +1,23 @@
 //! API contract for `root` context.
+use std::env;
+
 use torrust_index_backend::web::api;
 
 use crate::common::asserts::{assert_response_title, assert_text_ok};
 use crate::common::client::Client;
+use crate::e2e::config::ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL;
 use crate::e2e::environment::TestEnv;
 
 #[tokio::test]
 async fn it_should_load_the_about_page_at_the_api_entrypoint() {
     let mut env = TestEnv::new();
     env.start(api::Implementation::ActixWeb).await;
+
+    if env::var(ENV_VAR_E2E_EXCLUDE_ACTIX_WEB_IMPL).is_ok() {
+        println!("Skipped");
+        return;
+    }
+
     let client = Client::unauthenticated(&env.server_socket_addr().unwrap());
 
     let response = client.root().await;