refactor: testing and coverage

.github/workflows/coverage.yml

@@ -1,73 +1,23 @@
 name: Coverage
 
-on:
+on: [pull_request, push]
-  push:
-#     branches:
-#       - develop
-#   pull_request_target:
-#     branches:
-#       - develop
-
-env:
-  CARGO_TERM_COLOR: always
 
 jobs:
-  report:
+  coverage:
-    name: Report
-    environment: coverage
     runs-on: ubuntu-latest
     env:
-      CARGO_INCREMENTAL: "0"
+      CARGO_TERM_COLOR: always
-      RUSTFLAGS: "-Z profile -C codegen-units=1 -C inline-threshold=0 -C link-dead-code -C overflow-checks=off -C panic=abort -Z panic_abort_tests"
-      RUSTDOCFLAGS: "-Z profile -C codegen-units=1 -C inline-threshold=0 -C link-dead-code -C overflow-checks=off -C panic=abort -Z panic_abort_tests"
-
     steps:
-      - id: checkout_push
+      - uses: actions/checkout@v4
-        if: github.event_name  == 'push'
+      - name: Install Rust
-        name: Checkout Repository (Push)
+        run: rustup update stable
-        uses: actions/checkout@v4
+      - name: Install cargo-llvm-cov
-
+        uses: taiki-e/install-action@cargo-llvm-cov
-      - id: checkout_pull_request_target
+      - name: Generate code coverage
-        if: github.event_name  == 'pull_request_target'
+        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
-        name: Checkout Repository (Pull Request Target)
+      - name: Upload coverage to Codecov
-        uses: actions/checkout@v4
-        with:
-          ref: "refs/pull/${{ github.event.pull_request.number }}/head"
-
-      - id: setup
-        name: Setup Toolchain
-        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: nightly
-          components: llvm-tools-preview
-
-      - id: cache
-        name: Enable Workflow Cache
-        uses: Swatinem/rust-cache@v2
-
-      - id: tools
-        name: Install Tools
-        uses: taiki-e/install-action@v2
-        with:
-          tool: grcov
-
-      - id: check
-        name: Run Build Checks
-        run: cargo check --tests --benches --examples --workspace --all-targets --all-features
-
-      - id: test
-        name: Run Unit Tests
-        run: cargo test --tests --benches --examples --workspace --all-targets --all-features
-
-      - id: coverage
-        name: Generate Coverage Report
-        uses: actions-rs/grcov@v0.1.5
-
-      - id: upload
-        name: Upload Coverage Report
         uses: codecov/codecov-action@v3
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          files: lcov.info
-          files: ${{ steps.coverage.outputs.report }}
-          verbose: true
           fail_ci_if_error: true
+

tests/config_type_tests.rs

@@ -0,0 +1,14 @@
+#[cfg(test)]
+mod tests {
+    use rustysearch::types::config::Config;
+
+    #[test]
+    fn test_search_engine() {
+        let config = Config::default();
+        let config_two = Config::new();
+        println!("{:?}", config);
+        println!("{:?}", config_two);
+
+        // assert_eq!(config.http, 1);
+    }
+}

tests/search_engine_tests.rs

@@ -1,6 +1,6 @@
 #[cfg(test)]
 mod tests {
-    use rustysearch::search::engine::SearchEngine;
+    use rustysearch::search::engine::{remove_index_from_disk, SearchEngine};
 
     #[test]
     fn test_search_engine() {
@@ -12,6 +12,8 @@ mod tests {
         assert_eq!(result.len(), 1);
         assert_eq!(search_engine.posts().len(), 1);
         assert_eq!(search_engine.number_of_documents(), 1);
+
+        remove_index_from_disk();
     }
 
     #[test]
@@ -25,5 +27,8 @@ mod tests {
 
         assert_eq!(search_engine.posts().len(), 2);
         assert_eq!(search_engine.number_of_documents(), 2);
+
+        remove_index_from_disk();
     }
 }
+

tests/search_handler_tests.rs

@@ -3,7 +3,11 @@ mod tests {
     use std::sync::Mutex;
 
     use actix_web::{test, web, App};
-    use rustysearch::{handlers::search, search::engine::SearchEngine, types::app_state::AppStateWithSearchEngine};
+    use rustysearch::{
+        handlers::search,
+        search::engine::{remove_index_from_disk, SearchEngine},
+        types::app_state::AppStateWithSearchEngine,
+    };
 
     #[actix_web::test]
     async fn test_add_document_to_index() {
@@ -13,13 +17,11 @@ mod tests {
             search_engine: Mutex::new(search_engine.clone()),
         });
 
-        let app = test::init_service(App::new()
+        let app = test::init_service(App::new().app_data(app_state.clone()).route(
-            .app_data(app_state.clone())
+            "/search/index/document",
-            .route(
+            web::post().to(search::add_document_to_index),
-                "/search/index/document",
+        ))
-                web::post().to(search::add_document_to_index),
+        .await;
-            )
-        ).await;
 
         let data = search::AddDocumentRequest {
             url: "https://example.com".to_string(),
@@ -33,6 +35,8 @@ mod tests {
 
         let resp = test::call_service(&app, req).await;
         assert!(resp.status() == 201);
+
+        remove_index_from_disk();
     }
 
     #[actix_web::test]
@@ -44,13 +48,11 @@ mod tests {
             search_engine: Mutex::new(search_engine.clone()),
         });
 
-        let app = test::init_service(App::new()
+        let app = test::init_service(App::new().app_data(app_state.clone()).route(
-            .app_data(app_state.clone())
+            "/search/index/number_of_documents",
-            .route(
+            web::get().to(search::get_number_of_documents),
-                "/search/index/number_of_documents",
+        ))
-                web::get().to(search::get_number_of_documents),
+        .await;
-            )
-        ).await;
 
         let req = test::TestRequest::get()
             .uri("/search/index/number_of_documents")
@@ -58,6 +60,8 @@ mod tests {
 
         let resp = test::call_service(&app, req).await;
         assert!(resp.status() == 200);
+
+        remove_index_from_disk();
     }
 
     #[actix_web::test]
@@ -69,10 +73,12 @@ mod tests {
             search_engine: Mutex::new(search_engine.clone()),
         });
 
-        let app = test::init_service(App::new()
+        let app = test::init_service(
-            .app_data(app_state.clone())
+            App::new()
-            .route("/search", web::get().to(search::search))
+                .app_data(app_state.clone())
-        ).await;
+                .route("/search", web::get().to(search::search)),
+        )
+        .await;
 
         let req = test::TestRequest::get()
             .uri("/search?query=example")
@@ -80,6 +86,8 @@ mod tests {
 
         let resp = test::call_service(&app, req).await;
         assert!(resp.status() == 200);
+
+        remove_index_from_disk();
     }
 
     #[actix_web::test]
@@ -90,16 +98,19 @@ mod tests {
             search_engine: Mutex::new(search_engine.clone()),
         });
 
-        let app = test::init_service(App::new()
+        let app = test::init_service(
-            .app_data(app_state.clone())
+            App::new()
-            .route("/search/debug", web::get().to(search::debug_index))
+                .app_data(app_state.clone())
-        ).await;
+                .route("/search/debug", web::get().to(search::debug_index)),
+        )
+        .await;
 
-        let req = test::TestRequest::get()
+        let req = test::TestRequest::get().uri("/search/debug").to_request();
-            .uri("/search/debug")
-            .to_request();
 
         let resp = test::call_service(&app, req).await;
         assert!(resp.status() == 200);
+
+        remove_index_from_disk();
     }
 }
+