test: test

Yag000 · Sep 1, 2023 · d309a51 · d309a51
1 parent 004f835
commit d309a51
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 65 deletions.
diff --git a/.github/workflows/general.yml b/.github/workflows/general.yml
@@ -1,89 +1,68 @@
 name: Rust
 
-on: [push, pull_request]
+on:
+  # NB: this differs from the book's project!
+  # These settings allow us to run this specific CI pipeline for PRs against
+  # this specific branch (a.k.a. book chapter).
+  push:
+    branches:
+      - root-chapter-05
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - root-chapter-05
 
 env:
-  CARGO_TERM_COLOR: always  
+  CARGO_TERM_COLOR: always
   SQLX_VERSION: 0.6.2
   SQLX_FEATURES: "rustls,postgres"
 
-# A workflow run is made up of one or more jobs, which run in parallel by default
-# Each job runs in a runner environment specified by runs-on
 jobs:
-  # Unique identifier of our job (`job_id`)
   test:
-    # Sets the name `Test` for the job, which is displayed in the GitHub UI
     name: Test
-    # Containers must run in Linux based operating systems
     runs-on: ubuntu-latest
-    # Service containers to run with the `test` container job
     services:
-      # Label used to access the service container
       postgres:
-        # Docker Hub image 
         image: postgres:14
-        # Environment variables scoped only for the `postgres` element
         env:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: password
           POSTGRES_DB: postgres
-        # When you map ports using the ports keyword, GitHub uses the --publish command to publish the container’s ports to the Docker host
-        # Opens tcp port 5432 on the host and service container
         ports:
           - 5432:5432
     steps:
-        # Downloads a copy of the code in your repository before running CI tests
-      - name: Check out repository code
-        # The uses keyword specifies that this step will run v3 of the actions/checkout action. 
-        # This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools).
-        # You should use the checkout action any time your workflow will run against the repository's code.
-        uses: actions/checkout@v3
-
-       # This GitHub Action installs a Rust toolchain using rustup. It is designed for one-line concise usage and good defaults.
-      - name: Install the Rust toolchain
-        uses: dtolnay/rust-toolchain@stable
-
-      # A GitHub Action that implements smart caching for rust/cargo projects with sensible defaults.
-      - name: Rust Cache Action
-        uses: Swatinem/rust-cache@v2
+      - uses: actions/checkout@v3
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
         with:
-          # An additional cache key that is added alongside the automatic `job`-based cache key and can be used to further differentiate jobs. default: empty
           key: sqlx-${{ env.SQLX_VERSION }}
-
       - name: Install sqlx-cli
-        run:
-            cargo install sqlx-cli
-            --version=${{ env.SQLX_VERSION }}
-            --features ${{ env.SQLX_FEATURES }}
-            --no-default-features
-            --locked
-            # The --locked flag can be used to force Cargo to use the packaged Cargo.lock file if it is available. 
-            # This may be useful for ensuring reproducible builds, to use the exact same set of dependencies that were available when the package was published. 
-            # It may also be useful if a newer version of a dependency is published that no longer builds on your system, or has other problems
-
-      - name: Install postgresql-client
-        run: sudo apt-get update && sudo apt-get install postgresql-client -y
-
+        run: cargo install sqlx-cli
+          --version=${{ env.SQLX_VERSION }}
+          --features ${{ env.SQLX_FEATURES }}
+          --no-default-features
+          --locked
       - name: Migrate database
-        run: SKIP_DOCKER=true ./scripts/init_db.sh
-
+        run: |
+          sudo apt-get install libpq-dev -y
+          SKIP_DOCKER=true ./scripts/init_db.sh
+      - name: Check sqlx-data.json is up-to-date
+        run: |
+          cargo sqlx prepare --check -- --bin zero2prod
       - name: Run tests
         run: cargo test
 
-  # `fmt` container job
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
         with:
-          # Specific to dtolnay/rust-toolchain: Comma-separated string of additional components to install
           components: rustfmt
       - name: Enforce formatting
         run: cargo fmt --check
 
-  # `clippy` container job
   clippy:
     name: Clippy
     runs-on: ubuntu-latest
@@ -105,20 +84,18 @@ jobs:
         with:
           key: sqlx-${{ env.SQLX_VERSION }}
       - name: Install sqlx-cli
-        run:
-          cargo install sqlx-cli
-            --version=${{ env.SQLX_VERSION }}
-            --features ${{ env.SQLX_FEATURES }}
-            --no-default-features
-            --locked
-      - name: Install postgresql-client
-        run: sudo apt-get update && sudo apt-get install postgresql-client -y
+        run: cargo install sqlx-cli
+          --version=${{ env.SQLX_VERSION }}
+          --features ${{ env.SQLX_FEATURES }}
+          --no-default-features
+          --locked
       - name: Migrate database
-        run: SKIP_DOCKER=true ./scripts/init_db.sh
+        run: |
+          sudo apt-get install libpq-dev -y
+          SKIP_DOCKER=true ./scripts/init_db.sh
       - name: Linting
         run: cargo clippy -- -D warnings
 
-  # `coverage` container job
   coverage:
     name: Code coverage
     runs-on: ubuntu-latest
@@ -135,19 +112,20 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
       - uses: dtolnay/rust-toolchain@stable
-      - name: Install postgresql-client
+      - name: Install libpq
         run: sudo apt-get update && sudo apt-get install postgresql-client -y
       - uses: Swatinem/rust-cache@v2
         with:
           key: sqlx-${{ env.SQLX_VERSION }}
+      - name: Install tarpaulin
+        run: cargo install cargo-tarpaulin
       - name: Install sqlx-cli
-        run:
-          cargo install sqlx-cli
+        run: cargo install sqlx-cli
           --version=${{ env.SQLX_VERSION }}
           --features ${{ env.SQLX_FEATURES }}
           --no-default-features
           --locked
       - name: Migrate database
         run: SKIP_DOCKER=true ./scripts/init_db.sh
       - name: Generate code coverage
-        run: cargo install cargo-tarpaulin && cargo tarpaulin --verbose --workspace
+        run: cargo tarpaulin --verbose --workspace
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -17,8 +17,8 @@ actix-web = "4"
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
 serde = "1.0.115"
 config = { version = "0.13", default-features = false, features = ["yaml"] }
-sqlx = { version = "0.6", default-features = false, features = ["runtime-actix-rustls", "macros", "postgres", "uuid", "chrono", "migrate"] }
 uuid = { version = "1", features = ["v4"] }
+sqlx = { version = "0.6", default-features = false, features = ["runtime-actix-rustls", "macros", "postgres", "uuid", "chrono", "migrate", "offline"] }
 chrono = { version = "0.4.22", default-features = false, features = ["clock"] }
 tracing = { version = "0.1", features = ["log"] }
 tracing-subscriber = { version = "0.3", features = ["registry", "env-filter"] }
@@ -30,3 +30,5 @@ tracing-actix-web = "0.7"
 
 [dev-dependencies]
 reqwest = { version = "0.11", features = ["json"] }
+
+
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,8 @@
+FROM rust:1.71.0
+WORKDIR /app
+RUN apt update && apt install lld clang -y
+COPY . .
+ENV SQLX_OFFLINE true
+RUN cargo build --release
+# When `docker run` is executed, launch the binary!
+ENTRYPOINT ["./target/release/zero2prod
diff --git a/sqlx-data.json b/sqlx-data.json
@@ -0,0 +1,3 @@
+{
+  "db": "PostgreSQL"
+}
diff --git a/src/main.rs b/src/main.rs
@@ -9,6 +9,7 @@ use zero2prod::{configurations::get_configuration, startup::run, telemetry::get_
 async fn main() -> Result<(), std::io::Error> {
     // Logger setup
     LogTracer::init().expect("Failed to set logger");
+
     // Info or above will be logged if the RUST_LOG environment variable is not set
     let subscriber = get_subscriber("zero2prod".into(), "info".into(), std::io::stdout);
     set_global_default(subscriber).expect("Failed to set subscriber");
@@ -22,7 +23,8 @@ async fn main() -> Result<(), std::io::Error> {
             .expose_secret(),
     )
     .await
-    .expect("Failed to connect to Postgresf");
+    .expect("Failed to connect to Postgres");
+
     // Bind the TCP listener socket address with the configuration port
     let address = format!("127.0.0.1:{}", configuration.application_port);
     let listener = TcpListener::bind(address).expect("Failed to bind random port");