Merge pull request #10 from thuan2172001/main

thuan2172001 · web-flow · commit 23fbed64a5a6 · 2024-02-25T00:07:15.000+07:00
Feat: add CI into project
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -0,0 +1,8 @@
+
+version: 2
+updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    rebase-strategy: "disabled"
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,120 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  cargo-check:
+    name: Cargo check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: actions-rs/cargo@v1
+        with:
+          command: check
+
+  fmt-check:
+    name: Rust fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - run: rustup component add rustfmt
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+  test-and-coverage:
+    name: Test and Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          rustup self update
+          rustup update
+          cargo install cargo-tarpaulin
+
+      - name: Run tests with coverage
+        run: |
+          cargo tarpaulin --all-features --verbose
+
+  release-github-artifact:
+    name: Release Packaging
+    env:
+      PROJECT_NAME_UNDERSCORE: rust-api-server
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [cargo-check, fmt-check, test-and-coverage]
+    steps:
+      - name: Check out from Git
+        uses: actions/checkout@v4
+      - name: Grant permission to run command
+        run: echo 'ACTIONS_ALLOW_UNSECURE_COMMANDS=true' >> $GITHUB_ENV
+      - name: Check if Git tag exists
+        run: echo "::set-env name=HEAD_TAG::$(git tag --points-at HEAD)"
+      - name: Skip if Git tag does not exist
+        if: steps.check-tag.outputs.HEAD_TAG == ''
+        run: exit 0 # Exit with success, effectively skipping subsequent steps
+
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: Release Build
+        run: cargo build --release
+      - name: "Upload Artifact"
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ env.PROJECT_NAME_UNDERSCORE }}
+          path: target/release/${{ env.PROJECT_NAME_UNDERSCORE }}
+
+  release-docker-image:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [cargo-check, fmt-check, test-and-coverage]
+    steps:
+      - name: Check out from Git
+        uses: actions/checkout@v4
+      - name: Grant permission to run command
+        run: echo 'ACTIONS_ALLOW_UNSECURE_COMMANDS=true' >> $GITHUB_ENV
+      - name: Check if Git tag exists
+        run: echo "::set-env name=HEAD_TAG::$(git tag --points-at HEAD)"
+      - name: Skip if Git tag does not exist
+        if: steps.check-tag.outputs.HEAD_TAG == ''
+        run: exit 0 # Exit with success, effectively skipping subsequent steps
+
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          target: prod
+          load: true
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-target/
+target/
+results.xml
diff --git a/README.md b/README.md
@@ -70,6 +70,15 @@ Hierarchical child config via env, separated by using `__`. Specify list values
 
 Make sure to set these environment variables according to your needs before running the server.
 
+## GitHub Flow CI Configuration
+
+1. **Set Docker Hub Secrets:**
+   - Go to repository Settings > Secrets.
+   - Add `DOCKER_USERNAME` and `DOCKERHUB_TOKEN`.
+
+2. **Enable Dependabot Alerts:**
+   - In repository Insights, enable "Dependabot alerts" and "Security & Analysis."
+
 ## Checklist
 
 ### Basic Functionalities
@@ -94,11 +103,11 @@ Demonstrate proficiency in advanced development practices including:
 2. [x] Load Configuration from a File.
 3. [x] Multiple Implementations.
 4. [x] Advanced Tracing.
-5. [ ] CI/CD.
+5. [x] CI/CD.
     1. [ ] Migrate DB tool/image.
-    2. [ ] Publish binary artifacts in [Github](https://github.com/).
-    3. [ ] Push Docker images.
-    4. [ ] 
+    2. [x] Publish binary artifacts in [Github](https://github.com/).
+    3. [x] Push Docker images.
+    4. [x] 
        Deploy [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)
 6. [x] Docker Image Optimization.
 7. [x] Load test using [K6](https://k6.io/).
diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -15,9 +15,11 @@
 /// // Start the server with default configuration
 /// main();
 /// ```
+
+#[cfg_attr(debug_assertions, allow(dead_code, unused_imports))]
 use openssl;
 
-#[macro_use]
+#[cfg_attr(debug_assertions, allow(dead_code, unused_imports))]
 use diesel;
 
 mod options;
@@ -40,7 +42,7 @@ use std::str::FromStr;
 use std::sync::Arc;
 
 use library::adapter::repositories::postgres::question_db::QuestionDBRepository;
-use tracing::{error, info};
+use tracing::info;
 
 /// Simple REST server.
 #[derive(Parser, Debug)]
@@ -49,7 +51,7 @@ struct Args {
     #[command(subcommand)]
     command: Option<Commands>,
     /// Config file
-    #[arg(short, long, default_value = "config/default.toml")]
+    #[arg(short, long, default_value = "config/00-default.toml")]
     config_path: Vec<String>,
     /// Print version
     #[clap(short, long)]
@@ -66,7 +68,7 @@ enum Commands {
 #[tokio::main]
 async fn main() {
     let args = Args::parse();
-    if args.version == true {
+    if args.version {
         println!(env!("APP_VERSION"));
         return;
     }
diff --git a/library/src/adapter/repositories/postgres/models/question.rs b/library/src/adapter/repositories/postgres/models/question.rs
@@ -4,7 +4,7 @@ use serde::Serialize;
 use std::time::SystemTime;
 
 #[derive(Debug, Queryable, Serialize, Selectable, Insertable, AsChangeset, Identifiable)]
-#[table_name = "super::super::schema::questions"]
+#[diesel(table_name = super::super::schema::questions)]
 #[cfg_attr(feature = "postgres", derive(diesel::pg::Pg))]
 pub struct QuestionModel {
     pub id: i32,
diff --git a/library/src/core/ports/question.rs b/library/src/core/ports/question.rs
@@ -87,7 +87,7 @@ mod tests {
         assert_eq!(result.unwrap(), updated_question);
 
         let result = question_port.delete(&question_id).await;
-        assert_eq!(result.is_ok(), true);
+        assert!(result.is_ok());
     }
 
     #[tokio::test]
@@ -103,10 +103,10 @@ mod tests {
         let docker = Cli::default();
         let postgres_instance = docker.run(Postgres::default());
 
-        let database_url = String::from(format!(
+        let database_url = format!(
             "postgres://postgres:postgres@127.0.0.1:{}/postgres",
             postgres_instance.get_host_port_ipv4(5432)
-        ));
+        );
         let database_config = DatabaseConfig {
             url: database_url.clone(),
             max_size: 10,
diff --git a/library/tests/mod.rs b/library/tests/mod.rs
@@ -1 +1 @@
-mod questions_router_test;
+mod questions_router_test;
diff --git a/library/tests/questions_router_test.rs b/library/tests/questions_router_test.rs
@@ -3,7 +3,7 @@ mod tests {
         postgres::{Pool, Runtime},
         Manager,
     };
-    use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
+    use diesel_migrations::MigrationHarness;
     use library::{
         adapter::repositories::{
             in_memory::question::QuestionInMemoryRepository,
@@ -72,7 +72,7 @@ mod tests {
 
         // Deserialize the response body into a Value
         let get_question: QuestionEntity =
-            serde_json::from_slice(&get_resp.body()).expect("Failed to deserialize response body");
+            serde_json::from_slice(get_resp.body()).expect("Failed to deserialize response body");
 
         assert_eq!(
             get_question, question,
@@ -118,7 +118,7 @@ mod tests {
         );
 
         // Deserialize the response body into a Value
-        let get_updated_question: QuestionEntity = serde_json::from_slice(&get_updated_resp.body())
+        let get_updated_question: QuestionEntity = serde_json::from_slice(get_updated_resp.body())
             .expect("Failed to deserialize response body");
 
         assert_eq!(
@@ -173,10 +173,10 @@ mod tests {
         let docker = Cli::default();
         let postgres_instance = docker.run(Postgres::default());
 
-        let database_url = String::from(format!(
+        let database_url = format!(
             "postgres://postgres:postgres@127.0.0.1:{}/postgres",
             postgres_instance.get_host_port_ipv4(5432)
-        ));
+        );
         let database_config = DatabaseConfig {
             url: database_url.clone(),
             max_size: 10,

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-mod questions_router_test;`
	`1`	`+mod questions_router_test;`