Skip to content

Commit

Permalink
New methods of building/installing PyThemis (#1023)
Browse files Browse the repository at this point in the history
Refactor Makefile:
* new target pythemis_make_wheel to create a .whl Python package,
  current modern format to be installed into virtual environmants
* new target pythemis_install_wheel to install it in currently active virtualenv
* new target deb_python that builds a .deb package for system-wide
  installation of PyThemis
* new target pythemis_install_deb, alias for pythemis_deb + apt install of
  the created pkg
* new target rpm_python, similar to deb_python
* new target pythemis_install_rpm, pythemis_install_deb

Update GitHub Actions workflow, test .whl and .deb installation

See cossacklabs/product-docs/pull/317 for related docs update
  • Loading branch information
iamnotacake authored Nov 28, 2023
1 parent 30578c8 commit 784033b
Show file tree
Hide file tree
Showing 3 changed files with 163 additions and 2 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/test-python.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,69 @@ jobs:
- name: Run test suite
run: make test_python

unit-tests-venv:
name: Unit tests (virtualenv install)
# TODO: Switch to something more fresh, Ubuntu 22.04 or Debian Bookworm,
# after issue with deprecates in C++ tests is fixed
runs-on: ubuntu-20.04
steps:
- name: Install system dependencies
run: |
sudo sh -c 'echo "DEBIAN_FRONTEND=noninteractive" >> /etc/environment'
sudo apt update
sudo apt install --yes gcc make libssl-dev \
python3 python3-setuptools python3-pip python3-venv
- name: Check out code
uses: actions/checkout@v2
- name: Prepare Themis Core
run: |
make
sudo make install
make prepare_tests_all
- name: Create virtualenv
run: mkdir /tmp/test_venv && python3 -m venv /tmp/test_venv
- name: Install PyThemis into virtualenv
run: |
make pythemis_make_wheel
source /tmp/test_venv/bin/activate && make pythemis_install_wheel
- name: Run test suite
run: source /tmp/test_venv/bin/activate && make test_python
- name: Uninstall PyThemis
run: source /tmp/test_venv/bin/activate && pip uninstall -y pythemis

unit-tests-deb-pkg:
name: Unit tests (deb package)
# TODO: Switch to something more fresh, Ubuntu 22.04 or Debian Bookworm,
# after issue with deprecates in C++ tests is fixed
runs-on: ubuntu-20.04
steps:
- name: Install system dependencies
run: |
sudo sh -c 'echo "DEBIAN_FRONTEND=noninteractive" >> /etc/environment'
sudo apt update
sudo apt install --yes gcc make libssl-dev \
python3 python3-setuptools \
ruby
sudo gem install fpm
- name: Check out code
uses: actions/checkout@v2
- name: Prepare Themis Core
run: |
make
sudo make install
make prepare_tests_all
- name: Install libthemis deb
run: |
make deb WITHOUT_THEMISPP=1 WITHOUT_JAVA=1
sudo apt install ./build/deb/libthemis_*.deb
- name: Install PyThemis (deb package)
run: |
sudo make pythemis_install_deb
- name: Run test suite
run: make test_python
- name: Uninstall PyThemis
run: sudo apt remove -y python3-pythemis

examples:
name: Code examples
runs-on: ubuntu-20.04
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ _Code:_

- `pythemis.scomparator` and `pythemis.skeygen` are now imported with `from pythemis import *` ([#914](https://github.com/cossacklabs/themis/pull/914)).

- New installation methods, accessible with make ([#1023](https://github.com/cossacklabs/themis/pull/1023)).
- create/install `.whl` package for virtualenv
- create/install `.deb` or `.rpm` package for system-wide installation

- **Ruby**

- Improved compatibility with non-standard installations on Apple M1 ([#917](https://github.com/cossacklabs/themis/pull/917)).
Expand Down
98 changes: 96 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ $(BUILD_PATH)/configure.mk:
# then increment LIBRARY_SO_VERSION as well, and update package names.
VERSION := $(shell test -d .git && git describe --tags || cat VERSION)
LIBRARY_SO_VERSION = 0
# Version in format X.Y.Z, without build number and commit hash
VERSION_SHORT := $(shell cat VERSION)

#----- Toolchain ---------------------------------------------------------------

Expand Down Expand Up @@ -412,7 +414,7 @@ fmt: $(FMT_FIXUP)
fmt_check: $(FMT_CHECK)

clean: CMD = rm -rf $(BIN_PATH)
clean: nist_rng_test_suite_clean clean_rust
clean: nist_rng_test_suite_clean clean_rust clean_python
@$(BUILD_CMD)

clean_rust:
Expand All @@ -421,6 +423,12 @@ ifdef RUST_VERSION
@rm -f tools/rust/*.rust
endif

clean_python:
ifdef PYTHON3_VERSION
@rm -rf src/wrappers/themis/python/dist
@rm -rf src/wrappers/themis/python/pythemis.egg-info
endif

get_version:
@echo $(VERSION)

Expand Down Expand Up @@ -621,6 +629,25 @@ endif
@echo -n "pythemis install "
@$(BUILD_CMD_)

pythemis_make_wheel: CMD = cd src/wrappers/themis/python/ && python3 setup.py bdist_wheel
pythemis_make_wheel:
ifeq ($(PYTHON3_VERSION),)
@echo "python3 not found"
@exit 1
endif
@echo -n "pythemis make wheel "
@$(BUILD_CMD_)
@echo Result: src/wrappers/themis/python/dist/pythemis-$(VERSION_SHORT)-py2.py3-none-any.whl

pythemis_install_wheel: CMD = pip install src/wrappers/themis/python/dist/pythemis-$(VERSION_SHORT)-py2.py3-none-any.whl
pythemis_install_wheel:
ifeq ($(PYTHON3_VERSION),)
@echo "python3 not found"
@exit 1
endif
@echo -n "pythemis install wheel "
@$(BUILD_CMD_)

########################################################################
#
# Packaging Themis Core: Linux distributions
Expand Down Expand Up @@ -743,7 +770,7 @@ deb: PREFIX = /usr
deb: libdir = $(PREFIX)$(DEB_LIBDIR)
deb: jnidir = $(PREFIX)$(DEB_LIBDIR)/jni

deb: install themispp_install themis_jni_install
deb: install $(if $(WITHOUT_THEMISPP), , themispp_install) $(if $(WITHOUT_JAVA), , themis_jni_install)
@printf "ldconfig" > $(POST_INSTALL_SCRIPT)
@printf "ldconfig" > $(POST_UNINSTALL_SCRIPT)

Expand All @@ -764,6 +791,7 @@ deb: install themispp_install themis_jni_install
--after-install $(POST_INSTALL_SCRIPT) \
--after-remove $(POST_UNINSTALL_SCRIPT) \
--category $(PACKAGE_CATEGORY) \
--force \
$(foreach file,$(DEV_PACKAGE_FILES),$(DESTDIR)/$(file)=$(file))

@fpm --input-type dir \
Expand All @@ -781,8 +809,10 @@ deb: install themispp_install themis_jni_install
--after-remove $(POST_UNINSTALL_SCRIPT) \
--deb-priority optional \
--category $(PACKAGE_CATEGORY) \
--force \
$(foreach file,$(LIB_PACKAGE_FILES),$(DESTDIR)/$(file)=$(file))

ifndef WITHOUT_THEMISPP
@fpm --input-type dir \
--output-type deb \
--name $(DEB_THEMISPP_PACKAGE_NAME) \
Expand All @@ -798,8 +828,11 @@ deb: install themispp_install themis_jni_install
--after-install $(POST_INSTALL_SCRIPT) \
--after-remove $(POST_UNINSTALL_SCRIPT) \
--category $(PACKAGE_CATEGORY) \
--force \
$(foreach file,$(THEMISPP_PACKAGE_FILES),$(DESTDIR)/$(file)=$(file))
endif

ifndef WITHOUT_JAVA
@fpm --input-type dir \
--output-type deb \
--name $(JNI_PACKAGE_NAME) \
Expand All @@ -815,10 +848,44 @@ deb: install themispp_install themis_jni_install
--after-remove $(POST_UNINSTALL_SCRIPT) \
--deb-priority optional \
--category $(PACKAGE_CATEGORY) \
--force \
$(foreach file,$(JNI_PACKAGE_FILES),$(DESTDIR)/$(file)=$(file))
endif

@find $(BIN_PATH) -name \*.deb

# Use builtin feature of fpm to create a .deb package from a Python package dir.
# Dependencies are automatically added, i.e. PyThemis depends on `six`, so fpm will add `python3-six` to deps.
deb_python: DEB_ARCHITECTURE = all
deb_python: DESTDIR = $(BIN_PATH)/deb/pythemis_root
deb_python:
@mkdir -p $(BIN_PATH)/deb
@fpm --input-type python \
--output-type deb \
--python-bin=python3 \
--python-package-name-prefix=python3 \
--name python3-pythemis \
--license $(LICENSE_NAME) \
--url '$(COSSACKLABS_URL)' \
--description '$(SHORT_DESCRIPTION)' \
--maintainer $(MAINTAINER) \
--package $(BIN_PATH)/deb/python3-pythemis_$(NAME_SUFFIX) \
--architecture $(DEB_ARCHITECTURE) \
--version $(VERSION)+$(OS_CODENAME) \
--depends python3 --depends libthemis \
--deb-priority optional \
--category $(PACKAGE_CATEGORY) \
--force \
src/wrappers/themis/python

@echo $(BIN_PATH)/deb/python3-pythemis_$(NAME_SUFFIX)

# Using `apt` since it could install dependencies (we depend on python3-six),
# while dpkg would just complain about missing dependency and fail
pythemis_install_deb: DEB_ARCHITECTURE = all
pythemis_install_deb: deb_python
apt install ./$(BIN_PATH)/deb/python3-pythemis_$(NAME_SUFFIX)

rpm: MODE_PACKAGING = 1
rpm: DESTDIR = $(BIN_PATH)/rpm/root
rpm: PREFIX = /usr
Expand Down Expand Up @@ -896,6 +963,33 @@ rpm: install themispp_install themis_jni_install

@find $(BIN_PATH) -name \*.rpm

rpm_python: ARCHITECTURE = all
rpm_python:
@mkdir -p $(BIN_PATH)/rpm
@fpm --input-type python \
--output-type rpm \
--python-bin=python3 \
--python-package-name-prefix=python3 \
--name python3-pythemis \
--license $(LICENSE_NAME) \
--url '$(COSSACKLABS_URL)' \
--description '$(SHORT_DESCRIPTION)' \
--rpm-summary '$(RPM_SUMMARY)' \
--maintainer $(MAINTAINER) \
--package $(BIN_PATH)/rpm/python3-pythemis_$(NAME_SUFFIX) \
--version $(RPM_VERSION) \
--depends python3 --depends libthemis \
--category $(PACKAGE_CATEGORY) \
--force \
src/wrappers/themis/python

@echo $(BIN_PATH)/rpm/python3-pythemis_$(NAME_SUFFIX)

pythemis_install_rpm: ARCHITECTURE = all
pythemis_install_rpm: rpm_python
yum install ./$(BIN_PATH)/rpm/python3-pythemis_$(NAME_SUFFIX)


########################################################################
#
# Packaging Themis Core: Windows (NSIS)
Expand Down

0 comments on commit 784033b

Please sign in to comment.