jenkins file

Jenkinsfile

@@ -1,64 +1,86 @@
-pipeline{
-    agent {label 'workers'} // needs to have ssh agent
-    parameters{
-        string(name: 'sleep_time', defaultValue:'2', description:'time to sleep')
-        string(name: 'UNAME', defaultValue:'silentmobius', description:'docker_username')
-        string(name: 'PASSWD', description:'docker_password')
-        string(name: 'docker_image_name', defaultValue:'details_app', description:'docker image name')
-        string(name: 'docker_image_version', defaultValue:'latest', description:'docker image version')
-        string(name: 'registry_user', defaultValue:'silentmobius', description:'docker hub user')
-
-    }
-    stages{
-        stage('Pre-Build'){
-            steps{
-                echo 'Checking pre-requisites'
-                sleep "${sleep_time}"
-                sh'''
-                    export PATH=$PATH:~/.local/bin
-                    sudo apt-get update
-                    sudo apt-get install -y wget curl python3 python3-poetry codespell
-                    curl -L get.docker.com| sudo bash
-                    poetry install
-                '''
+pipeline {
+    agent any
+    stages {
+        stage('Pre-Build: Install Dependencies') {
+            steps {
+                script {
+                    sh '''
+                        # Update package lists and install system dependencies
+                        sudo apt-get update
+                        sudo apt-get install -y wget curl python3 python3-pip python3-venv shellcheck aspell
+
+                        # Install Poetry
+                        curl -sSL https://install.python-poetry.org | python3 -
+
+                        # Add Poetry to PATH
+                        export PATH="$HOME/.local/bin:$PATH"
+
+                        # Configure Poetry to create and use virtual environments in the project directory
+                        poetry config virtualenvs.create true
+                        poetry config virtualenvs.in-project true
+
+                        if [ -f "poetry.lock" ]; then
+                            poetry lock --no-update
+                        else
+                            echo "poetry.lock not found. Skipping lock file regeneration."
+                        fi
+
+                        poetry install
+                    '''
+                }
+            }
+        }
+        stage('Spell Check') {
+            steps {
+                script {
+                    sh '''
+                        . .venv/bin/activate
+                        aspell list < README.md > spelling_errors.txt
+
+                        # fail the build if there are spelling mistakes
+                        if [ -s spelling_errors.txt ]; then
+                            echo "Spelling mistakes found. Failing the build."
+                            cat spelling_errors.txt
+                            exit 1
+                        else
+                            echo "No spelling mistakes found."
+                        fi
+                    '''
+                }
             }
         }
-        stage('Linter'){
-            steps{
-                echo 'Static code analysis check'
-                sleep "${sleep_time}"
-                sh '''
-                    codespell  app.py
-                '''
-            } // error app syntax --> fix the strings in app or bypass them
+        stage('Shellcheck') {
+            steps {
+                script {
+                    sh '''
+                        shellcheck build.sh
+                    '''
+                }
+            }
         }
-        stage('Build'){
-            steps{
-                echo 'Building the Project'
-                sleep "${sleep_time}"
-                sh '''
-                    sudo docker build -t details-app:latest .
-                '''
-            } // error with builds clean up 
+        stage('Test') {
+            steps {
+                script {
+                    sh '''
+                        . .venv/bin/activate
+                        # poetry run pytest
+                    '''
+                }
+            }
         }
-        stage('Docker image Save'){
-            steps{
-                echo 'Testing'
-                sleep "${sleep_time}"
-                sh"""
-                    sudo docker login -u ${UNAME} -p ${PASSWD} 
-                    sudo docker tag ${docker_image_name}:${docker_image_version} ${registry_user}/${docker_image_name}:${docker_image_version} 
-                    sudo docker push ${registry_user}/${docker_image_name}:${docker_image_version} 
-                """ 
+        stage('Build Docker Image') {
+            steps {
+                script {
+                    sh '''
+                        docker build -t details-app:latest .
+                    '''
+                }
             }
         }
-    }// comment to check things
+    }
     post {
-        success{
-            sh""""
-                docker save ${registry_user}/${docker_image_name}:${docker_image_version}  -o "${docker_image_name}:${docker_image_version}.tgz"
-            """
-            archiveArtifacts artifacts: 'details_app_docker.latest.tgz', followSymlinks: false, onlyIfSuccessful: true      
+        always {
+            cleanWs()
         }
     }
 }

README.md

@@ -1,20 +1,75 @@
-# Details App
+# Jenkins Pipeline Configuration
+![image](https://github.com/user-attachments/assets/d5ba7c2d-6c93-4f5e-ba47-39ddddeaf339)
 
-Applications that can store your personal details and list all the written users on html
 
-### Requirements:
+## Description
 
-- Python: 3.11
-- SQLite3
-- Bash Shell
-- Docker
-    - Postgresql container needed
-- Docker compose for multi container environment
-- k3s for simple testing
-- Virtualbox for k8s setup for more deep dive into world of container orchestrations
+This repository contains a Jenkins pipeline configuration designed to automate several tasks related to Python development and Docker image building. The pipeline performs the following stages:
 
-### Install
+1. **Pre-Build: Install Dependencies**:
+   - Updates system packages.
+   - Installs essential system dependencies such as `wget`, `curl`, `python3`, `python3-pip`, `python3-venv`, `shellcheck`, and `aspell`.
+   - Installs and configures [Poetry](https://python-poetry.org/) for managing Python dependencies.
 
-### Setup
+2. **Spell Check**:
+   - Activates the virtual environment created by Poetry.
+   - Uses `aspell` to check for spelling mistakes in the `README.md` file.
+   - Fails the build if any spelling errors are found.
 
+3. **Shellcheck**:
+   - Checks the syntax of shell scripts using `shellcheck`.
+   - Currently configured to check `build.sh`.
 
+4. **Test**:
+   - Activates the virtual environment.
+   - Runs Python tests using `pytest`. (Note: This stage is currently commented out due to non existing pytests in the project.)
+
+5. **Build Docker Image**:
+   - Builds a Docker image with the tag `details-app:latest` using a Dockerfile in the repository.
+
+## What It Actually Does
+
+The Jenkins pipeline automates the setup of the development environment, performs code quality checks (spell checking and shell script linting), and builds a Docker image. However, the pipeline faces a permission issue when attempting to build the Docker image.
+
+## Identified Gaps
+
+1. **Docker Permission Issue**:
+   - **Error**: `permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock`.
+   - **Cause**: The Jenkins user does not have the necessary permissions to access the Docker daemon.
+   - **Resolution**: Ensure the Jenkins user is added to the `docker` group and has appropriate permissions. Restart Jenkins and Docker services after making changes.
+
+2. **Pytest Not Executing**:
+   - **Issue**: The `pytest` command is commented out in the pipeline configuration.
+   - **Resolution**: Add tests to ensure Python tests are executed.
+
+## How to Use
+
+1. **Set Up Jenkins**:
+   - Ensure Jenkins is installed and configured.
+   - Add Jenkins user to the Docker group: `sudo usermod -aG docker jenkins`.
+   - Restart Jenkins: `sudo systemctl restart jenkins`.
+
+2. **Configure Pipeline**:
+   - Copy the Jenkins pipeline configuration into a Jenkinsfile and place it in the repository.
+
+3. **Build Docker Image**:
+   - Ensure that Docker is running and accessible.
+   - Verify that all required system dependencies are installed.
+
+4. **Run Pipeline**:
+   - Trigger the Jenkins pipeline to execute the defined stages.
+
+## Installation and Running Instructions
+
+Clone the repository:
+
+   ```sh
+   git clone https://github.com/nastyak6/details-app/tree/nastya
+
+
+Contributors
+
+    Anastasia Kokin
+    Charlie Haimov
+
+    No Mamon agreement, so 50-50 it is :)

build.sh

@@ -5,4 +5,6 @@
 # Version: 0.0.1
 # Date: 14.06.2024
 #################################################
- APP_VERSION=${1:'0.0.1'}
+ APP_VERSION=${1:'0.0.1'}
+
+ echo "$APP_VERSION"

docker-compose.yml

@@ -0,0 +1,43 @@
+services:
+    main:
+        hostname: jenkins_main
+        build:
+            context: .
+            dockerfile: Dockerfile.main
+        ports:
+            - "80:8080"
+        networks:
+            - jenkins
+        volumes:
+            - /var/run/docker.sock:/var/run/docker.sock
+            - ../jenkins_data:/var/jenkins_home
+
+    worker1:
+        hostname: jenkins_worker1
+        build:
+            context: .
+            dockerfile: Dockerfile.deb.worker
+
+        networks:
+            - jenkins
+        environment:
+            SSH_USERNAME: jenkins
+            SSH_USERPASS: jenkins
+        volumes:
+            - /var/run/docker.sock:/var/run/docker.sock
+
+    worker2:
+        hostname: jenkins_worker2
+        build:
+            context: .
+            dockerfile: Dockerfile.rpm.worker
+
+        networks:
+            - jenkins
+        environment:
+            SSH_USERNAME: jenkins
+            SSH_USERPASS: jenkins
+        volumes:
+            - /var/run/docker.sock:/var/run/docker.sock   
+networks:
+    jenkins: