build: upgrades used base docker image to Ubuntu 24.04. (#244)

Author: Artanias

.github/workflows/check_n_push_image.yml

@@ -19,26 +19,26 @@ on:
 
 jobs:
   check-code:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.10
+    - name: Set up Python 3.12
       uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.12'
 
     - name: Lint with ruff and pyright
       run: |
         make substitute-sources
         pip install $(python3 setup.py --install-requirements)
         pip install $(python3 setup.py --build-requirements)
+        pip install $(python3 setup.py --lint-requirements)
         pip install --requirement docs/notebooks/requirements.txt
-        pip install pre-commit==4.3.0
         make pre-commit
 
   docker-build-test-autotest:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 
@@ -56,13 +56,13 @@ jobs:
       - name: Get current util version
         id: get_version
         run: |
-          echo "::set-output name=version::$(grep --max-count 1 UTIL_VERSION Makefile | grep -Eo "[0-9]+[.][0-9]+[.][0-9]+")"
+          echo "::set-output name=version::$(grep -Po '^version\s*=\s*"\K[\d.]+' pyproject.toml)"
 
       - name: Create main docker image, run tests and save image for the next job
         run: |
           export $(cat .env | xargs)
-          make docker-image DOCKER_TAG=${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu22.04:${{ steps.get_version.outputs.version }}
-          docker image save --output /tmp/codeplag-ubuntu22.04.tar ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu22.04:${{ steps.get_version.outputs.version }}
+          make docker-image DOCKER_TAG=${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu24.04:${{ steps.get_version.outputs.version }}
+          docker image save --output /tmp/codeplag-ubuntu24.04.tar ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu24.04:${{ steps.get_version.outputs.version }}
 
       - name: Pytest coverage comment
         uses: MishaKav/pytest-coverage-comment@v1
@@ -86,13 +86,13 @@ jobs:
         if: ${{ startsWith(github.event.ref, 'refs/tags/v') }}
         uses: actions/upload-artifact@v4
         with:
-          name: codeplag-ubuntu22.04
-          path: /tmp/codeplag-ubuntu22.04.tar
+          name: codeplag-ubuntu24.04
+          path: /tmp/codeplag-ubuntu24.04.tar
           retention-days: 1
           if-no-files-found: error
 
   push-image:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     needs: [check-code, docker-build-test-autotest]
     if: startsWith(github.event.ref, 'refs/tags/v')
 
@@ -103,7 +103,7 @@ jobs:
       - name: Download created in the previous stage image
         uses: actions/download-artifact@v4
         with:
-          name: codeplag-ubuntu22.04
+          name: codeplag-ubuntu24.04
           path: /tmp
 
       - name: Get current util version
@@ -113,8 +113,8 @@ jobs:
 
       - name: Load Docker created image
         run: |
-          docker load --input /tmp/codeplag-ubuntu22.04.tar
-          docker image tag ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu22.04:${{ steps.get_version.outputs.version }} ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu22.04:latest
+          docker load --input /tmp/codeplag-ubuntu24.04.tar
+          docker image tag ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu24.04:${{ steps.get_version.outputs.version }} ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu24.04:latest
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3
@@ -123,4 +123,4 @@ jobs:
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
 
       - name: Push docker image
-        run: docker image push --all-tags ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu22.04
+        run: docker image push --all-tags ${{ secrets.DOCKER_HUB_USERNAME }}/codeplag-ubuntu24.04

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
 default_language_version:
-    python: python3.10
+    python: python3.12
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.2
+    rev: v0.14.3
     hooks:
       - id: ruff
         args: [ --fix ]

CONTRIBUTING.md

@@ -4,7 +4,7 @@ First of all thank you for your desire to contribute in that project.
 
 ## Development environment
 
-Before starting work with this project you need to install [Python 3.10](https://www.python.org/), [Docker](https://www.docker.com/) (for commands like 'make docker-test').
+Before starting work with this project you need to install [Python 3.12](https://www.python.org/), [Docker](https://www.docker.com/) (for commands like 'make docker-test').
 
 After that you'll need to install and setup pre-commit hooks for checking style of source code, formatting it and checking types:
 

Makefile

@@ -1,15 +1,14 @@
-UTIL_VERSION            := 0.5.30
-UTIL_NAME               := codeplag
-PWD                     := $(shell pwd)
+UTIL_VERSION            := $(shell grep -Po '^version\s*=\s*"\K[\d.]+' pyproject.toml)
+UTIL_NAME               := $(shell grep -Po '^name\s*=\s*"\K\w+' pyproject.toml)
 
 USER_UID                ?= $(shell id --user)
 USER_GID                ?= $(shell id --group)
 
-BASE_DOCKER_VERSION     := 1.3
-DIST                    := ubuntu22.04
-BASE_DOCKER_TAG         := $(shell echo $(UTIL_NAME)-base-${DIST}:$(BASE_DOCKER_VERSION))
-TEST_DOCKER_TAG         := $(shell echo $(UTIL_NAME)-test-${DIST}:$(UTIL_VERSION))
-DOCKER_TAG              ?= $(shell echo $(UTIL_NAME)-${DIST}:$(UTIL_VERSION))
+BASE_DOCKER_VERSION     := 1.0
+DIST                    := ubuntu24.04
+BASE_DOCKER_TAG         := "$(UTIL_NAME)-base-${DIST}:$(BASE_DOCKER_VERSION)"
+TEST_DOCKER_TAG         := "$(UTIL_NAME)-test-${DIST}:$(UTIL_VERSION)"
+DOCKER_TAG              ?= "$(UTIL_NAME)-${DIST}:$(UTIL_VERSION)"
 
 PYTHONDONTWRITEBYTECODE := "1"
 PYTHONPATH              := $(PWD)/src/:$(PWD)/test/auto
@@ -85,7 +84,9 @@ install: substitute-sources man translate-compile
 
 	@echo "Cleaning unnecessary files after Cython compilation in $(PY_INSTALL_PATH)"
 	find "$(DESTDIR)/$(PY_INSTALL_PATH)/$(UTIL_NAME)/" -type f -name '*.py' -exec rm --force '{}' +
+	find "$(DESTDIR)/$(PY_INSTALL_PATH)/$(UTIL_NAME)/" -type f -name '*.c' -exec rm --force '{}' +
 	find "$(DESTDIR)/$(PY_INSTALL_PATH)/$(UTIL_NAME)" -type d -iname "__pycache__" -exec rm --recursive --force '{}' +
+	find "$(DESTDIR)/$(PY_INSTALL_PATH)/webparsers" -type d -iname "__pycache__" -exec rm --recursive --force '{}' +
 
 	@echo "Cleaning unnecessary temporary Python files after installation in $(PY_INSTALL_PATH)"
 	find "$(DESTDIR)/$(PY_INSTALL_PATH)/$(UTIL_NAME)/" -type f -name '*.tmp.py' -exec rm --force '{}' +

README.md

@@ -50,8 +50,8 @@ Program for finding plagiarism in the source code written in Python 3, C, and C+
 ### 1.3 Install with package manager apt-get
 
 - Requirements:
-  - OS Ubuntu Linux == 22.04
-  - Python version == 3.10
+  - OS Ubuntu Linux == 24.04
+  - Python version == 3.12
 
 - For this purpose, you need to get installing package from releases [tab](https://github.com/OSLL/code-plagiarism/releases) with extension .deb;
 - The next step is run commands on the target system:
@@ -81,8 +81,8 @@ If you want to use MongoDB cache for saving reports and works metadata, complete
   # Before local checking, you need to install dependencies into your virtual environment.
   $ python3 -m pip install --requirement docs/notebooks/requirements.txt
   $ python3 -m pip install $(python3 -m setup.py --build-requirements)
+  $ python3 -m pip install $(python3 -m setup.py --lint-requirements)
   $ python3 -m pip install $(python3 -m setup.py --install-requirements)
-  $ python3 -m pip install pre-commit==4.3.0
   $ make pre-commit
   ```
 

debian/control.in

@@ -6,6 +6,6 @@ Build-Depends: debhelper (>= 10)
 
 Package: @UTIL_NAME@-util
 Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}, python3 (>= 3.10), python3-pip (>= 19.0),
- clang, libncurses5, man
+Depends: ${shlibs:Depends}, ${misc:Depends}, python3 (>= 3.12), python3-pip (>= 19.0),
+ clang, libncurses6, man
 Description: Program for finding plagiarism in the source code written on Python3, C, C++ based on compare AST metadata.

debian/preinst.in

@@ -2,4 +2,4 @@
 
 echo "Pre installation ($@) ..."
 
-pip3 install @PYTHON_REQUIRED_LIBS@
+pip3 install --break-system-packages @PYTHON_REQUIRED_LIBS@

docker/base_ubuntu2204.dockerfile docker/base_ubuntu2404.dockerfiledocker/base_ubuntu2204.dockerfile renamed to docker/base_ubuntu2404.dockerfile

@@ -1,4 +1,4 @@
-FROM ubuntu:22.04
+FROM ubuntu:24.04
 
 ARG PYTHON_REQUIRED_LIBS
 ARG UTIL_NAME
@@ -9,13 +9,18 @@ RUN if  [ "$(dpkg-divert --truename /usr/bin/man)" = "/usr/bin/man.REAL" ]; then
         dpkg-divert --quiet --remove --rename /usr/bin/man; \
     fi
 RUN apt-get update
-RUN apt-get install -y python3-pip
-RUN pip3 install --upgrade setuptools
-RUN apt-get install -y clang libncurses5
-RUN apt-get install -y man
-RUN apt-get install -y vim nano less
+RUN apt-get install -y --no-install-recommends \
+    python3-pip \
+    clang \
+    libncurses6 \
+    vim \
+    nano \
+    less
+RUN apt-get clean
 
-RUN pip3 install $PYTHON_REQUIRED_LIBS
+RUN pip3 install --break-system-packages $PYTHON_REQUIRED_LIBS
+
+RUN rm --recursive --force /tmp/* /var/tmp/*
 
 VOLUME /usr/src/works
 WORKDIR /usr/src/$UTIL_NAME

…/base_ubuntu2204.dockerfile.dockerignore …/base_ubuntu2404.dockerfile.dockerignoredocker/base_ubuntu2204.dockerfile.dockerignore renamed to docker/base_ubuntu2404.dockerfile.dockerignore docker/base_ubuntu2204.dockerfile.dockerignore renamed to docker/base_ubuntu2404.dockerfile.dockerignore

@@ -28,7 +28,7 @@ docker-base-image: substitute-sources substitute-docker
 			--tag "$(BASE_DOCKER_TAG)" \
 			--build-arg PYTHON_REQUIRED_LIBS="$(PYTHON_REQUIRED_LIBS)" \
 			--build-arg UTIL_NAME="$(UTIL_NAME)" \
-			--file docker/base_ubuntu2204.dockerfile \
+			--file docker/base_ubuntu2404.dockerfile \
 			. \
 	)
 
@@ -42,7 +42,7 @@ docker-test-image: docker-base-image
 		--build-arg PYTHON_BUILD_LIBS="$(PYTHON_BUILD_LIBS)" \
 		--build-arg LOGS_PATH="$(LOGS_PATH)" \
 		--build-arg UTIL_NAME="$(UTIL_NAME)" \
-		--file docker/test_ubuntu2204.dockerfile \
+		--file docker/test_ubuntu2404.dockerfile \
 		.
 
 .PHONY: docker-test-mongo-run
@@ -109,7 +109,7 @@ docker-image: docker-base-image docker-test-image
 			--build-arg UTIL_NAME="$(UTIL_NAME)" \
 			--build-arg DEBIAN_PACKAGES_PATH="$(DEBIAN_PACKAGES_PATH)" \
 			--build-arg DEB_PKG_NAME="$(DEB_PKG_NAME)" \
-			--file docker/ubuntu2204.dockerfile \
+			--file docker/ubuntu2404.dockerfile \
 			. \
 	)