ci/cd pipeline

.github/workflows/ci-cd.yml

@@ -0,0 +1,49 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+  pull_request:
+    branches: [main]
+
+jobs:
+  ci:
+    if: github.event_name != 'push' || !startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '^1.20'
+      - name: Lint
+        uses: golangci/golangci-lint-action@v4
+        with:
+          version: latest
+          working-directory: server
+
+      - name: Test
+        run: go test ./internal/...
+        working-directory: server
+
+      - name: Build
+        run: go build ./...
+        working-directory: server
+
+  cd:
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '^1.20'
+      - name: Build release binary
+        run: go build -o build/app
+        working-directory: server
+
+      - name: Upload binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-binaries
+          path: server/build/ 

.github/workflows/static-analysis.yml

@@ -0,0 +1,36 @@
+name: Static Analysis (golangci-lint)
+
+on:
+  pull_request:
+    paths:
+      - 'server/**.go'
+      - 'server/go.mod'
+      - 'server/go.sum'
+  push:
+    branches: [ main ]
+    paths:
+      - 'server/**.go'
+      - 'server/go.mod'
+      - 'server/go.sum'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+
+      - name: Install golangci-lint
+        uses: golangci/golangci-lint-action@v4
+        with:
+          version: latest
+          working-directory: server
+          args: --timeout=5m
+
+      - name: Run golangci-lint
+        run: golangci-lint run ./server/... --timeout=5m

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "githubPullRequests.ignoredPullRequestBranches": [
+        "main"
+    ]
+}

CONTRIBUTING.md

@@ -1,42 +1,78 @@
-# Guidelines for Contributing to This Repository
 
-We’re glad you want to contribute! To get started, please **fork the repository**, create your own branch from your fork, and follow the guidelines below to ensure your changes align with the project’s workflow and quality standards.
+# Guidelines for Contributing to CodeLookout
 
-## Working on changes
+We’re glad you want to contribute! Please read these rules and setup instructions before submitting a pull request.
 
-- Always **create a new branch** for your work.
-- **Push regularly** to avoid data loss.
-- We follow a **linear commit history** — always use `git rebase` instead of `git merge`.
+## Contribution Rules
 
-## Branch naming conventions
+- **Fork the repository** and create a new branch for your work.
+- **Branch naming:**
+	- New features: `feature/<feature-name>`
+	- Bug fixes: `fix/<bug-description>`
+	- Hotfixes: `hotfix/<critical-fix>`
+	- Security: `security/<change>`
+	- Maintenance: `maintenance/<task>`
+	- Other/dev: `<username>/<description>`
+- **Push regularly** to your branch.
+- **Linear commit history:** Use `git rebase` (not `git merge`).
+- **Pull Requests:**
+	- Use clear, descriptive titles and detailed descriptions.
+	- Reference related issues if applicable.
+	- Use **Squash and Merge** after approval.
+- **Commit messages:**
+	- Write clear, meaningful commit messages ([guide](https://cbea.ms/git-commit/)).
+- **Tests:**
+	- Add or update tests for new features and bug fixes.
+- **Code style:**
+	- Follow Go best practices and project conventions.
+- **Review:**
+	- Address all review comments before merging.
 
-Branch names should reflect the purpose of the work and follow a consistent structure.
+## Local Setup Instructions
 
-### Recommended patterns
+Follow these steps to set up CodeLookout for local development:
 
-| Type                   | Pattern                    | Example                                          | Notes                                                |
-| ---------------------- | -------------------------- | ------------------------------------------------ | ---------------------------------------------------- |
-| New Features           | `feature/<feature-name>`   | `feature/integrate-openai-apis-for-code-summary` | For new user-facing features                         |
-| Bug Fixes              | `fix/<fix-name>`           | `fix/auth-error`                                 | For bug fixes                                        |
-| Hotfixes               | `hotfix/<fix-name>`        | `hotfix/breaking-changes-openai-sdk`             | For urgent, critical fixes                           |
-| Security Updates/Fixes | `security/<change>`        | `security/suppress-server-headers`               | For security-related changes                         |
-| Maintenance            | `maintenance/<task>`       | `maintenance/run-integration-tests-in-workflows` | For internal improvements or upkeep                  |
-| Development / Other    | `<username>/<description>` | `alex/job-queue-poc`                             | For work not covered above; often temporary branches |
+1. **Clone your fork and install dependencies:**
+	 ```sh
+	 git clone https://github.com/<your-username>/CodeLookout.git
+	 cd CodeLookout
+	 cd server
+	 go mod download
+	 ```
 
-> **Tip:** Avoid vague names like `fix/bug-fix`. Be clear and descriptive.
+2. **Configure environment variables:**
+	 - Copy or create a `.env` file (see `server/development.md` for details).
+	 - Set up a local PostgreSQL and Redis instance, or use Docker Compose.
 
-## Pull request conventions
+3. **Run database migrations:**
+	 ```sh
+	 ./scripts/run_migrations.sh
+	 ```
 
-GitHub will automatically apply the default PR template located [here](https://github.com/Mentro-Org/CodeLookout/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
+4. **Start the development server:**
+	 - With Docker Compose:
+		 ```sh
+		 docker-compose up
+		 ./scripts/run_smeeclient.sh  # For GitHub webhook forwarding
+		 ```
+	 - Or locally:
+		 ```sh
+		 go run cmd/main.go
+		 ./scripts/run_smeeclient.sh
+		 ```
 
-### PR guidelines
+5. **Access the app:**
+	 - API: `http://localhost:8080/api/`
+	 - Analytics Dashboard: `http://localhost:8080/analytics`
 
-- **Title**: Clearly describe the purpose of the PR.
-- **Description**: Include a detailed explanation of what changes were made and why.
-- **Merge strategy**: Use **`Squash and Merge`** once all reviews and checks are approved.
+6. **Run/test LLM and SonarQube CLI tools:**
+	 ```sh
+	 make test-llm
+	 make test-sonarqube
+	 ```
 
-## Commit message conventions
+7. **See `server/development.md` for more details and troubleshooting.**
 
-Good commit messages are essential for a readable project history. Please follow this guide:
+---
 
-👉 [How to Write a Git Commit Message](https://cbea.ms/git-commit/)
+Thank you for contributing to CodeLookout!

server/.dev.env

@@ -11,4 +11,7 @@ OPENAI_API_KEY=your-openai-key
 DATABASE_URL=postgres://user:pass@localhost:5432/dbname
 # QUEUE_SIZE=100
 REDIS_ADDRESS=localhost:6379
-WORKER_CONCURRENCY=5
+WORKER_CONCURRENCY=5
+
+LLM_ENDPOINT="https://api-inference.huggingface.co/models/gpt2"
+LLM_AUTH_TOKEN="your_huggingface_token"   # (if required, or leave blank for public models)

server/Makefile

@@ -0,0 +1,10 @@
+# Makefile for testing LLM and SonarQube integrations
+
+.PHONY: test-llm test-sonarqube
+
+
+test-llm:
+	go run ./cmd/llm_cli/main.go
+
+test-sonarqube:
+	go run ./cmd/sonarqube_cli/main.go

server/architecture.md

@@ -1,35 +1,70 @@
 ## PR Review Processing Flow (Redis + Asynq + Worker)
 
-+----------------------+         +------------------------+           +------------------+
-|   GitHub Webhook     | ----->  |   HTTP Server (API)    |           |    AI Review     |
-|  (PR Open/Update)    |         | - Validates Webhook    |           |   Generator (LLM)|
-+----------------------+         | - Enqueues Task (Asynq)|           +------------------+
-                                 +------------------------+
-                                               |
-                                               v
-                                      +------------------+
-                                      |  Redis (Asynq DB)|
-                                      |  - Stores Queued |
-                                      |    Tasks         |
-                                      +------------------+
-                                               |
-                                               v
-                                +-----------------------------+
-                                |   Asynq Worker (Goroutine)  |
-                                | - Dequeues Task             |
-                                | - Fetches PR Diff           |
-                                | - Builds Prompt             |
-                                | - Calls AI API              |
-                                | - Posts Comments via GitHub |
-                                +-----------------------------+
+```mermaid
+flowchart LR
+    ghwebhook[GitHub Webhook PR Open or Update] --> httpapi[HTTP Server API]
+    httpapi --> redis[Redis Asynq DB]
+    redis --> worker[Asynq Worker]
+    worker --> ai[AI Review Engine LLM]
+    ai --> ghapi[GitHub API Post Comments]
+
+    httpapi --> validate[Validate Webhook]
+    validate --> enqueue[Enqueue Task Asynq]
+    enqueue --> redis
+
+    worker --> dequeue[Dequeues Task]
+    dequeue --> fetch[Fetch PR Diff]
+    fetch --> buildprompt[Build Prompt]
+    buildprompt --> callai[Call AI API]
+    callai --> postcomment[Post Comments]
+    postcomment --> ghapi
+
+```
+
++----------------------+ +------------------------+ +------------------+
+| GitHub Webhook | -----> | HTTP Server (API) | | AI Review |
+| (PR Open/Update) | | - Validates Webhook | | Generator (LLM)|
++----------------------+ | - Enqueues Task (Asynq)| +------------------+
++------------------------+
+|
+v
++------------------+
+| Redis (Asynq DB)|
+| - Stores Queued |
+| Tasks |
++------------------+
+|
+v
++-----------------------------+
+| Asynq Worker (Goroutine) |
+| - Dequeues Task |
+| - Fetches PR Diff |
+| - Builds Prompt |
+| - Calls AI API |
+| - Posts Comments via GitHub |
++-----------------------------+
 
 ## Understand graceful shutdown of services
-   ┌──────────────┐
-   │  main()      │
-   └────┬─────────┘
-        │
-        ├─ initializeDependencies()
-        ├─ signal listener goroutine ───┐
-        ├─ RunWorker() goroutine        │ (listens for ctx cancel)
-        ├─ startServer() goroutine      │ (listens for ctx cancel)
-        └─ wg.Wait() <──────────────────┘ waits for both
+
+```mermaid
+flowchart TD
+    main[main function] --> init[Initialize Dependencies]
+    init --> sig[SIGINT Listener Goroutine]
+    init --> runworker[Run Worker Goroutine]
+    init --> startserver[Start Server Goroutine]
+    sig --> wait[Wait for Shutdown]
+    runworker --> wait
+    startserver --> wait
+
+
+```
+
+┌──────────────┐
+│ main() │
+└────┬─────────┘
+│
+├─ initializeDependencies()
+├─ signal listener goroutine ───┐
+├─ RunWorker() goroutine │ (listens for ctx cancel)
+├─ startServer() goroutine │ (listens for ctx cancel)
+└─ wg.Wait() <──────────────────┘ waits for both

server/cmd/llm_cli/main.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+       "fmt"
+       "os"
+       "github.com/nalindalal/CodeLookout/server/internal/config"
+       "github.com/nalindalal/CodeLookout/server/internal/llm"
+)
+
+// This CLI demonstrates LLM integration using RESTLLMClient
+func main() {
+       cfg := config.Load()
+       if cfg.LLMEndpoint == "" {
+              fmt.Println("LLM_ENDPOINT not set in config. Exiting.")
+              os.Exit(1)
+       }
+       // Optionally support LLM_AUTH_TOKEN for HuggingFace
+       authToken := os.Getenv("LLM_AUTH_TOKEN")
+       client := &llm.RESTLLMClient{Endpoint: cfg.LLMEndpoint, AuthToken: authToken}
+       code := "func add(a int, b int) int { return a + b }"
+       fmt.Println("Sending code to LLM endpoint:", cfg.LLMEndpoint)
+       result, err := client.AnalyzeCode(code)
+       if err != nil {
+              fmt.Println("LLM error:", err)
+              os.Exit(1)
+       }
+       fmt.Println("LLM review result:")
+       fmt.Println(result)
+}