Adds CI & User Updater Setup (#35)

* adding build CI for user udpater Signed-off-by: danbugs <[email protected]> * clippy Signed-off-by: danbugs <[email protected]> * fmt Signed-off-by: danbugs <[email protected]> * update CI Signed-off-by: danbugs <[email protected]> * fixing build on windows, and adding caching Signed-off-by: danbugs <[email protected]> * added docker deploy action on PR merge onto main Signed-off-by: danbugs <[email protected]> * added caching to postgres Signed-off-by: danbugs <[email protected]> * meaningless change to test caching Signed-off-by: danbugs <[email protected]> * adding action for postgres and removing its caching 'cause it breaks build Signed-off-by: danbugs <[email protected]> * fixing CI Signed-off-by: danbugs <[email protected]> * fixing CI Signed-off-by: danbugs <[email protected]> --------- Signed-off-by: danbugs <[email protected]>
danbugs · Dec 24, 2023 · 634105e · 634105e
1 parent f0d6eaf
commit 634105e
Show file tree

Hide file tree

Showing 28 changed files with 315 additions and 157 deletions.
diff --git a/.cargo/config.toml b/.cargo/config.toml
@@ -1,3 +1,3 @@
 [target.x86_64-pc-windows-msvc.pq]
-rustc-link-search = ["C:\\Program Files\\PostgreSQL\\16\\lib"]
+rustc-link-search = ["C:\\Program Files\\PostgreSQL\\14\\lib"]
 rustc-link-lib = ["libpq"]
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint-and-format:
+    name: Lint with clippy and check formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          components: clippy, rustfmt
+          override: true
+
+      - name: Check formatting
+        run: cargo fmt -- --check
+
+      - name: Clippy check
+        run: cargo clippy -p smithe_backend -p smithe_database -p smithe_lib -p startgg -- -D warnings
+  build:
+    needs: lint-and-format
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+          - os: macos-latest
+            target: x86_64-apple-darwin
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Cache Rust dependencies
+      uses: Swatinem/rust-cache@v2
+
+
+    - name: Install Rust toolchain
+      uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: stable
+        override: true
+        target: ${{ matrix.target }}
+
+    - if: matrix.os == 'windows-latest'
+      name: Install PostgreSQL
+      uses: ikalnytskyi/action-setup-postgres@v4
+
+    - name: Build
+      run: cargo build --release --target ${{ matrix.target }}
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: my-binary-${{ matrix.target }}
+        path: target/${{ matrix.target }}/release/my-binary
diff --git a/.github/workflows/docker-deploy.yml b/.github/workflows/docker-deploy.yml
@@ -0,0 +1,23 @@
+name: Docker Deployment
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Download artifact
+      uses: actions/download-artifact@v2
+      with:
+        name: my-binary-x86_64-unknown-linux-gnu
+
+    - name: Build Docker image
+      run: |
+        docker build -t pidgtm-user-updater:latest -f Dockerfile-UserUpdater .
+        echo ${{ secrets.DOCKER_PASSWORD }} | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin
+        docker push pidgtm-user-updater:latest
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Dockerfile-UserUpdater b/Dockerfile-UserUpdater
@@ -0,0 +1,3 @@
+FROM debian:buster-slim
+COPY target/x86_64-unknown-linux-gnu/release/pidgtm /usr/local/bin/pidgtm
+ENTRYPOINT ["pidgtm"]
diff --git a/Makefile b/Makefile
@@ -5,9 +5,9 @@ SMITHE ?= target/release/smithe
 # CARGO
 .PHONY: improve
 improve:
-	cargo clippy --all --all-targets --all-features -- -D warnings
+	cargo clippy --fix -p smithe_backend -p smithe_database -p smithe_lib -p startgg
 	cargo fmt --all
-
+	
 .PHONY: test
 test:
 	cargo test --workspace -- --show-output 2>&1 | tee test.out
@@ -19,14 +19,18 @@ build:
 # INSTALL
 .PHONY: install
 install:
-	install target/release/smithe $(INSTALL_DIR)/bin
-	install target/release/pidgtm $(INSTALL_DIR)/bin
+	cargo install --path .
 
 # PIDGTM
 .PHONY: pidgtm
 pidgtm-map:
 	$(PIDGTM) map
 
+.PHONY: pidgtm-user-updater
+pidgtm-user-updater:
+	cargo build --release --bin pidgtm --target x86_64-unknown-linux-gnu
+	docker build -t pidgtm-user-updater -f Dockerfile-UserUpdater .
+
 # BACKEND
 .PHONY: build-backend
 build-backend:

diff --git a/README.md b/README.md
@@ -36,6 +36,16 @@ Smithereens is not yet available as a website, only as a command-line tool. With
 
 Currently, the only way to get Smithereens on your computer is to build it from source. To do so, you need to have the Rust toolchain installed on your machine. To install it, follow instructions [here](https://www.rust-lang.org/tools/install).
 
+> Note:
+>> Aside from the Rust toolchain, you will also need:
+>> - Postgres,
+>> - Diesel, and
+>> - Trunk.
+>
+>> Plus, you need the following Rust targets:
+>> - wasm32-unknown-unknown, and
+>> - x86_64-unknown-linux-gnu
+
 After that, inside of Smithereens' repository root, run: `cargo build --release`. With that, you'll have Smithereens' binary (i.e., `smithe`) built under `target/release`. You can run it, like: `./target/release/smithe`. After that, feel free to move the binary to a more convenient place on your machine (i.e., perhaps to a place included in your `PATH`, so you can run it simply with `smithe`).
 
-> Note: In the future, there will be releases for `smithe`, so this process will be better streamlined.
+> Note: In the future, there will be releases for `smithe`, so this process will be better streamlined.
diff --git a/backend/src/main.rs b/backend/src/main.rs
@@ -11,7 +11,7 @@ use smithe_lib::{
     player::{get_all_like, get_player, get_top_two_characters},
     set::{
         get_competitor_type, get_set_losses_by_dq, get_set_losses_without_dqs, get_set_wins_by_dq,
-        get_set_wins_without_dqs, get_winrate, get_sets_per_player_id,
+        get_set_wins_without_dqs, get_sets_per_player_id, get_winrate,
     },
     tournament::get_tournaments_from_requester_id,
 };
@@ -31,9 +31,7 @@ pub enum Error {
 impl<'r, 'o: 'r> Responder<'r, 'o> for Error {
     fn respond_to(self, req: &Request<'_>) -> response::Result<'o> {
         // todo: use open telemetry at this point
-        match self {
-            _ => Status::InternalServerError.respond_to(req),
-        }
+        Status::InternalServerError.respond_to(req)
     }
 }
 
@@ -149,7 +147,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
 #[cfg(test)]
 mod tests {
-    use rocket::{local::blocking::Client, http::Status};
+    use rocket::{http::Status, local::blocking::Client};
 
     use super::rocket;