Merge pull request #1 from rsachdeva/chatty

Implement Async TCP Chat System with High-throughput Server and Interactive CLI Client

Author: rsachdeva

.cargo/config.toml

@@ -0,0 +1,6 @@
+[env]
+# https://doc.rust-lang.org/cargo/reference/config.html#env
+RUST_LOG = { value = "chatty_types=info,chatty_tcp=info", force = true }
+
+TCP_SERVER_ADDRESS = "localhost"
+TCP_SERVER_PORT = "8081"

.githooks/pre-commit

@@ -0,0 +1,29 @@
+#!/bin/bash
+echo "Running pre-commit checks..."
+
+# Check formatting
+echo "Checking formatting..."
+cargo fmt --quiet -- --check
+if [ $? -ne 0 ]; then
+    echo "Formatting check failed. Please run 'cargo fmt' to fix"
+    exit 1
+fi
+
+# Run clippy
+echo "Running clippy..."
+cargo clippy --quiet -- -D warnings
+if [ $? -ne 0 ]; then
+    echo "Clippy check failed. Please fix the warnings"
+    exit 1
+fi
+
+# Compile check
+echo "Checking compilation..."
+cargo check --quiet
+if [ $? -ne 0 ]; then
+    echo "Compilation failed"
+    exit 1
+fi
+
+echo "All pre-commit checks passed!"
+exit 0

.github/workflows/rust.yml

@@ -0,0 +1,97 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'v*'  # This will match any branch starting with 'v'
+      - 'chatty*'# This will match any branch starting with 'chatty'
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Check Rust version
+        run: |
+          echo "Installed rustc version:"
+          rustc --version
+          echo "Installed cargo version:"
+          cargo --version
+
+      - name: Install Just
+        uses: extractions/setup-just@v2
+
+      - name: Check Just version
+        run: |
+          echo "Installed just version:"
+          just --version
+
+      - name: Build with Tests
+        run: |
+          just build-with-tests
+
+  verify-chat-connection:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Check Rust version
+        run: |
+          echo "Installed rustc version:"
+          rustc --version
+          echo "Installed cargo version:"
+          cargo --version
+
+      - name: Install Just
+        uses: extractions/setup-just@v2
+
+      - name: Check Just version
+        run: |
+          echo "Installed just version:"
+          just --version
+
+      - name: Start Chat Server
+        run: |
+          just run-chatty-tcp-server &
+          sleep 3
+
+      - name: Test Client Connection
+        run: |
+          TCP_SERVER_ADDRESS="localhost" TCP_SERVER_PORT="8081" cargo run --quiet --package chatty-tcp --bin client -- --username "rohit_s" < <(echo -e "send Hello World\nleave")
+  
+  
+  test:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Check Rust version
+        run: |
+          echo "Installed rustc version:"
+          rustc --version
+          echo "Installed cargo version:"
+          cargo --version
+
+      - name: Install Just
+        uses: extractions/setup-just@v2
+
+      - name: Check Just version
+        run: |
+          echo "Installed just version:"
+          just --version
+
+      - name: Run unit and integration tests
+        run: just test

.gitignore

@@ -2,13 +2,19 @@
 # will have compiled files and executables
 debug/
 target/
+private/
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
 
+# simple-chat is execuatle so should not be included in gitignore
+# so it is checked in the git repo
+# Cargo.lock
+
+# some extra files
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
+# Working on MacOS still per Github keeping this
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb