Skip to content

README.md

Latest commit

 

History

History
235 lines (152 loc) · 12.2 KB

README.md

File metadata and controls

235 lines (152 loc) · 12.2 KB

DevOps Assignment: Spring PetClinic CI/CD Pipeline Submitted by: Bar

Overview

This repository contains a fully automated CI/CD pipeline for the Spring PetClinic application. The solution automates the process from source code to a publicly available Docker image, ensuring a professional and scalable development workflow.

Pipeline Architecture:

Compile: Resolves all dependencies from Maven Central and compiles the source code.
Test: Runs the unit test suite to ensure application stability.
Package: Builds a runnable JAR file
Artifact to JFrog Uploads the JAR file to a JFrog Artifactory instance (bardpetclinic.jfrog.io) for binary management.
Build Docker Image: Creates a production-ready image based on the Dockerfile.
Push to Docker Hub: Tags and pushes the final image to a public registry.

Deliverables & Access
Jenkinsfile: (Compile -> Test -> Package -> Docker Build).
Dockerfile: Multi-stage/JRE-optimized build for the Java application.
Docker Hub Repository: lokokun290/spring-petclinic-bar
JFrog Artifactory: Integrated as a binary repository for artifact versioning.
Branch All work is done on the 'jenkins-pipeline' branch.

Spring PetClinic CI Pipeline

This project implements a full CI/CD pipeline using Jenkins and Docker.

Architecture
The pipeline consists of the following stages:

Compile: Resolves dependencies from Maven Central and compiles source code.

Test: Runs Unit tests.

Package: Builds a runnable JAR file (skipping tests for speed).

Build Image: Creates a Docker image containing the application.

How to Run :

option 1 - Run the pre-built image from Docker Hub :

docker run -p 8080:8080 lokokun290/spring-petclinic-bar:latest

option 2 - Build and Run locally :

git clone https://github.com/lokokun1/spring-petclinic.git
cd spring-petclinic

docker build -t spring-petclinic-bar .
docker run -p 8080:8080 spring-petclinic-bar

Access the app: Open http://localhost:8080 in your browser

---
hub.docker.com
https://hub.docker.com/repositories/lokokun290

lokokun290/spring-petclinic-bar:latest
lokokun290/jenkins:lts
---
# Spring PetClinic Sample Application [![Build Status](https://github.com/spring-projects/spring-petclinic/actions/workflows/maven-build.yml/badge.svg)](https://github.com/spring-projects/spring-petclinic/actions/workflows/maven-build.yml)[![Build Status](https://github.com/spring-projects/spring-petclinic/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/spring-projects/spring-petclinic/actions/workflows/gradle-build.yml)

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/spring-projects/spring-petclinic) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=7517918)

## Understanding the Spring Petclinic application with a few diagrams

See the presentation here:  
[Spring Petclinic Sample Application (legacy slides)](https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application?slide=20)

> **Note:** These slides refer to a legacy, pre–Spring Boot version of Petclinic and may not reflect the current Spring Boot–based implementation.  
> For up-to-date information, please refer to this repository and its documentation.


## Run Petclinic locally

Spring Petclinic is a [Spring Boot](https://spring.io/guides/gs/spring-boot) application built using [Maven](https://spring.io/guides/gs/maven/) or [Gradle](https://spring.io/guides/gs/gradle/).
Java 17 or later is required for the build, and the application can run with Java 17 or newer.

You first need to clone the project locally:

```bash
git clone https://github.com/spring-projects/spring-petclinic.git
cd spring-petclinic

If you are using Maven, you can start the application on the command-line as follows:

./mvnw spring-boot:run

With Gradle, the command is as follows:

./gradlew bootRun

You can then access the Petclinic at http://localhost:8080/.

petclinic-screenshot

You can, of course, run Petclinic in your favorite IDE. See below for more details.

Building a Container

There is no Dockerfile in this project. You can build a container image (if you have a docker daemon) using the Spring Boot build plugin:

./mvnw spring-boot:build-image

In case you find a bug/suggested improvement for Spring Petclinic

Our issue tracker is available here.

Database configuration

In its default configuration, Petclinic uses an in-memory database (H2) which gets populated at startup with data. The h2 console is exposed at http://localhost:8080/h2-console, and it is possible to inspect the content of the database using the jdbc:h2:mem:<uuid> URL. The UUID is printed at startup to the console.

A similar setup is provided for MySQL and PostgreSQL if a persistent database configuration is needed. Note that whenever the database type changes, the app needs to run with a different profile: spring.profiles.active=mysql for MySQL or spring.profiles.active=postgres for PostgreSQL. See the Spring Boot documentation for more detail on how to set the active profile.

You can start MySQL or PostgreSQL locally with whatever installer works for your OS or use docker:

docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:9.6

or

docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.3

Further documentation is provided for MySQL and PostgreSQL.

Instead of vanilla docker you can also use the provided docker-compose.yml file to start the database containers. Each one has a service named after the Spring profile:

docker compose up mysql

or

docker compose up postgres

Test Applications

At development time we recommend you use the test applications set up as main() methods in PetClinicIntegrationTests (using the default H2 database and also adding Spring Boot Devtools), MySqlTestApplication and PostgresIntegrationTests. These are set up so that you can run the apps in your IDE to get fast feedback and also run the same classes as integration tests against the respective database. The MySql integration tests use Testcontainers to start the database in a Docker container, and the Postgres tests use Docker Compose to do the same thing.

Compiling the CSS

There is a petclinic.css in src/main/resources/static/resources/css. It was generated from the petclinic.scss source, combined with the Bootstrap library. If you make changes to the scss, or upgrade Bootstrap, you will need to re-compile the CSS resources using the Maven profile "css", i.e. ./mvnw package -P css. There is no build profile for Gradle to compile the CSS.

Working with Petclinic in your IDE

Prerequisites

The following items should be installed in your system:

Steps

  1. On the command line run:

    git clone https://github.com/spring-projects/spring-petclinic.git

  2. Inside Eclipse or STS:

    Open the project via File -> Import -> Maven -> Existing Maven project, then select the root directory of the cloned repo.

    Then either build on the command line ./mvnw generate-resources or use the Eclipse launcher (right-click on project and Run As -> Maven install) to generate the CSS. Run the application's main method by right-clicking on it and choosing Run As -> Java Application.

  3. Inside IntelliJ IDEA:

    In the main menu, choose File -> Open and select the Petclinic pom.xml. Click on the Open button.

    • CSS files are generated from the Maven build. You can build them on the command line ./mvnw generate-resources or right-click on the spring-petclinic project then Maven -> Generates sources and Update Folders.

    • A run configuration named PetClinicApplication should have been created for you if you're using a recent Ultimate version. Otherwise, run the application by right-clicking on the PetClinicApplication main class and choosing Run 'PetClinicApplication'.

  4. Navigate to the Petclinic

    Visit http://localhost:8080 in your browser.

Looking for something in particular?

Spring Boot Configuration Class or Java property files
The Main Class PetClinicApplication
Properties Files application.properties
Caching CacheConfiguration

Interesting Spring Petclinic branches and forks

The Spring Petclinic "main" branch in the spring-projects GitHub org is the "canonical" implementation based on Spring Boot and Thymeleaf. There are quite a few forks in the GitHub org spring-petclinic. If you are interested in using a different technology stack to implement the Pet Clinic, please join the community there.

Interaction with other open-source projects

One of the best parts about working on the Spring Petclinic application is that we have the opportunity to work in direct contact with many Open Source projects. We found bugs/suggested improvements on various topics such as Spring, Spring Data, Bean Validation and even Eclipse! In many cases, they've been fixed/implemented in just a few days. Here is a list of them:

Name Issue
Spring JDBC: simplify usage of NamedParameterJdbcTemplate SPR-10256 and SPR-10257
Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility HV-790 and HV-792
Spring Data: provide more flexibility when working with JPQL queries DATAJPA-292

Contributing

The issue tracker is the preferred channel for bug reports, feature requests and submitting pull requests.

For pull requests, editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org. All commits must include a Signed-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin. For additional details, please refer to the blog post Hello DCO, Goodbye CLA: Simplifying Contributions to Spring.

License

The Spring PetClinic sample application is released under version 2.0 of the Apache License.