Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: Make Python bridge the default #19246

Merged
merged 4 commits into from
Sep 8, 2023
Merged

build: Make Python bridge the default #19246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f8586b
test: Increase testClientCertAuthentication page load timeout
martinpitt Sep 8, 2023
ffd68e3
tools: Change Debian pip install hack to use DEB_PYTHON_INSTALL_LAYOUT
martinpitt Sep 8, 2023
09bb24f
build: Uninstall Python bridge with `make uninstall`
martinpitt Sep 4, 2023
b82c60f
build: Make Python bridge the default
martinpitt Aug 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/unit-tests-refresh.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ jobs:
timeout-minutes: 15
run: containers/unit-tests/start --verbose --env=CC=clang --image-tag=i386 --make distcheck

- name: Run amd64 gcc distcheck test for C bridge
timeout-minutes: 15
run: containers/unit-tests/start --verbose --env=CC=gcc --env=EXTRA_DISTCHECK_CONFIGURE_FLAGS=--enable-old-bridge --image-tag=latest --make distcheck

- name: Run pytest-cov test
timeout-minutes: 15
run: containers/unit-tests/start --verbose --env=CC=gcc --image-tag=latest --make pytest-cov
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/unit-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ jobs:
startarg:
# avoid check-memory on i386, it has literally thousands of uninteresting/wrong errors
- { make: 'check-memory', cc: 'gcc', tag: 'latest' }
# with default Python bridge
- { make: 'distcheck', cc: 'clang', tag: 'latest' }
- { make: 'distcheck', cc: 'gcc', tag: 'i386' }
# with old C bridge
- { make: 'distcheck', cc: 'gcc', distcheck_flags: '--enable-old-bridge', tag: 'latest' }
martinpitt marked this conversation as resolved.
Show resolved Hide resolved
# this runs static code checks, unlike distcheck
- { make: 'check', cc: 'gcc', tag: 'latest' }
- { make: 'pytest-cov', cc: 'gcc', tag: 'latest' }
Expand Down Expand Up @@ -43,5 +46,6 @@ jobs:
--env=FORCE_COLOR=1 \
--env=CC='${{ matrix.startarg.cc }}' \
--env=CFLAGS='-O2 -gdwarf-4' \
--env=EXTRA_DISTCHECK_CONFIGURE_FLAGS='${{ matrix.startarg.distcheck_flags }}' \
--image-tag='${{ matrix.startarg.tag }}' \
--make '${{ matrix.startarg.make }}'
2 changes: 1 addition & 1 deletion Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ dist-hook: $(distdir)/tools/debian/copyright
$(distdir)/tools/debian/copyright: $(DIST_STAMP)
$(AM_V_GEN) NODE_ENV=$(NODE_ENV) $(srcdir)/tools/build-debian-copyright > $@

DISTCHECK_CONFIGURE_FLAGS = --enable-prefix-only
martinpitt marked this conversation as resolved.
Show resolved Hide resolved
DISTCHECK_CONFIGURE_FLAGS = --enable-prefix-only $(EXTRA_DISTCHECK_CONFIGURE_FLAGS)

# Validate our AppStream metadata
distcheck-hook::
Expand Down
14 changes: 7 additions & 7 deletions configure.ac
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ AC_ARG_ENABLE(ssh, AS_HELP_STRING([--disable-ssh], [Disable cockpit-ssh build an
AM_CONDITIONAL(WITH_COCKPIT_SSH, test "$enable_ssh" != "no")
AC_MSG_RESULT(${enable_ssh:=yes})

# --enable-pybridge
AC_MSG_CHECKING([whether to install the python cockpit-bridge])
AC_ARG_ENABLE(pybridge, AS_HELP_STRING([--enable-pybridge], [Install python cockpit-bridge]))
AM_CONDITIONAL(WITH_PYBRIDGE, test "$enable_pybridge" = "yes")
AC_MSG_RESULT(${enable_pybridge:=no})
# --enable-old-bridge
AC_MSG_CHECKING([whether to install the old C cockpit-bridge])
AC_ARG_ENABLE(old_bridge, AS_HELP_STRING([--enable-old-bridge], [Install old C cockpit-bridge]))
AM_CONDITIONAL(WITH_OLD_BRIDGE, test "$enable_old_bridge" = "yes")
AC_MSG_RESULT(${enable_old_bridge:=no})


# pkg-config
Expand Down Expand Up @@ -354,8 +354,8 @@ AC_ARG_ENABLE([cockpit-client],
AC_MSG_RESULT($enable_cockpit_client)
AM_CONDITIONAL([ENABLE_COCKPIT_CLIENT], [test "$enable_cockpit_client" = "yes"])

if test "$enable_cockpit_client" = "yes" && test "$enable_pybridge" = "no"; then
AC_MSG_ERROR([--enable-cockpit-client requires --enable-pybridge])
if test "$enable_cockpit_client" = "yes" && test "$enable_old_bridge" = "yes"; then
AC_MSG_ERROR([--enable-cockpit-client conflicts with --enable-old-bridge])
fi

# Debug
Expand Down
6 changes: 2 additions & 4 deletions containers/flatpak/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ INSTALL_FLATPAK_TARGETS = \
install-dist_scalableiconDATA \
install-dist_symboliciconDATA \
install-cockpit-client-symlink \
install-python \
install-bundles \
$(NULL)

if WITH_PYBRIDGE
INSTALL_FLATPAK_TARGETS += install-python install-bundles
endif

install-for-flatpak: $(INSTALL_FLATPAK_TARGETS)
appstream-util validate --nonet src/client/org.cockpit_project.CockpitClient.metainfo.xml
if test -s "${DOWNSTREAM_RELEASES_XML}"; then \
Expand Down
1 change: 0 additions & 1 deletion containers/flatpak/prepare
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ def create_manifest(
'buildsystem': 'autotools',
'config-opts': [
'--enable-cockpit-client',
'--enable-pybridge',
'--disable-polkit',
'--disable-ssh',
'--disable-pcp',
Expand Down
3 changes: 3 additions & 0 deletions containers/unit-tests/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ WORKDIR /home/builder

ENV LANG=C.UTF-8

# HACK: unbreak distcheck on Debian: https://bugs.debian.org/1035546
ENV DEB_PYTHON_INSTALL_LAYOUT=deb
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See https://salsa.debian.org/cpython-team/python3/-/blob/master/debian/patches/sysconfig-debian-schemes.diff#L56

Copy link
Member

@allisonkarlitskaya allisonkarlitskaya Sep 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I've wrapped my head around this situation properly then it also means that something like this, for example:

./configure
make
sudo make install

would result in Cockpit getting installed into /usr/local/local/ on Debian ...

Copy link
Member

@allisonkarlitskaya allisonkarlitskaya Sep 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The crux of the issue is that although sysconfig has a check for situations where the prefix is not the same as the base prefix (ie: venvs) it doesn't consider pip's --prefix flag when applying this logic...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

notes for myself:

  • check the sudo make install behaviour from above
  • possibly: toss away pip install and install the wheel ourselves; create single-line wrappers for cockpit-{bridge,askpass,beiboot} in our tree and install via scripts directory; use #!/usr/bin/env python3 hashbangs

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed a make install DESTDIR=/tmp/i in Debian creates /tmp/i/usr/local/local/lib/python3.11, and /tmp/i/usr/local/local/bin/cockpit-{bridge,askpass,beiboot} as we suspected.

I tried to convert to python3-installer:

--- src/Makefile.am
+++ src/Makefile.am
@@ -26,7 +26,7 @@ install-python:
        @# wheel-based installation with .dist-info.
        @# This needs to work on RHEL8 up through modern Fedora, offline, with
        @# system packages available to the build.
-       python3 -m pip install --no-index --force-reinstall --root='$(DESTDIR)/' --prefix='$(prefix)' \
+       python3 -m installer --destdir='$(DESTDIR)/' --prefix='$(prefix)' \
                "$$(python3 '$(srcdir)'/src/build_backend.py --wheel '$(srcdir)' tmp/wheel)"
        mkdir -p $(DESTDIR)$(libexecdir)
        mv -t $(DESTDIR)$(libexecdir) $(DESTDIR)$(bindir)/cockpit-askpass $(DESTDIR)$(bindir)/cockpit-beiboot

and it has the same problem. That's unsurprising, as the offending patch is in Debian's cpython, not in pip.


VOLUME /source

COPY entrypoint /
Expand Down
2 changes: 1 addition & 1 deletion pkg/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ EXTRA_DIST += build.js files.js package.json package-lock.json
# This is how the qunit tests get included. We need to prevent automake from
# seeing them during ./autogen.sh, but need make to find them at compile time.
# We don't run them in the pybridge case since they're part of `pytest`.
if !WITH_PYBRIDGE
if WITH_OLD_BRIDGE
-include $(wildcard pkg/Makefile.qunit*)
martinpitt marked this conversation as resolved.
Show resolved Hide resolved
endif

Expand Down
11 changes: 10 additions & 1 deletion src/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pytest-cov: $(BUILT_SOURCES) $(DIST_STAMP) $(MANIFESTS)
$(MAKE) test-server
cd '$(srcdir)' && abs_builddir='$(abs_builddir)' pytest --cov

if WITH_PYBRIDGE
if !WITH_OLD_BRIDGE
INSTALL_DATA_LOCAL_TARGETS += install-python
install-python:
@# wheel-based installation with .dist-info.
Expand All @@ -30,6 +30,15 @@ install-python:
"$$(python3 '$(srcdir)'/src/build_backend.py --wheel '$(srcdir)' tmp/wheel)"
mkdir -p $(DESTDIR)$(libexecdir)
mv -t $(DESTDIR)$(libexecdir) $(DESTDIR)$(bindir)/cockpit-askpass $(DESTDIR)$(bindir)/cockpit-beiboot

UNINSTALL_LOCAL_TARGETS += uninstall-python
uninstall-python:
rm -rf tmp/wheel
rm -f $(DESTDIR)$(libexecdir)/cockpit-askpass $(DESTDIR)$(libexecdir)/cockpit-beiboot
rm -f $(DESTDIR)$(bindir)/cockpit-bridge
@# HACK: pip uninstall does not know about --root and --prefix
rm -r $(DESTDIR)$(prefix)/lib/python*/*-packages/cockpit \
$(DESTDIR)$(prefix)/lib/python*/*-packages/cockpit-*.dist-info
endif


Expand Down
2 changes: 1 addition & 1 deletion src/bridge/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ libcockpit_metrics_a_SOURCES = \
src/bridge/cockpitsamples.h \
$(NULL)

if !WITH_PYBRIDGE
if WITH_OLD_BRIDGE

# -----------------------------------------------------------------------------
# libcockpit-bridge.a: code used in cockpit-bridge and its tests
Expand Down
2 changes: 1 addition & 1 deletion src/ws/Makefile-ws.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ test_kerberos_CPPFLAGS = $(libcockpit_ws_a_CPPFLAGS) $(TEST_CPP)
test_kerberos_LDADD = $(libcockpit_ws_a_LIBS) $(TEST_LIBS) $(krb5_LIBS)
test_kerberos_SOURCES = src/ws/test-kerberos.c

if !WITH_PYBRIDGE
if WITH_OLD_BRIDGE

# These are -ws tests but they involve invoking ./cockpit-bridge.

Expand Down
3 changes: 2 additions & 1 deletion test/verify/check-system-realms
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,8 @@ ipa-advise enable-admins-sudo | sh -ex
# and there is no ccache; so, emulate what cockpit-ssh could eventually do and check that *if* the
# session had the ticket forwarded, it *could* do sudo. See https://issues.redhat.com/browse/COCKPIT-643
b.open("/@x0.cockpit.lan/system/terminal")
b.enter_page("/system/terminal", host="x0.cockpit.lan")
with b.wait_timeout(60):
b.enter_page("/system/terminal", host="x0.cockpit.lan")
b.wait_in_text(".terminal .xterm-accessibility-tree", "alice")
b.key_press(f"{ccache_env} sudo whoami\r")
b.wait_in_text(".terminal .xterm-accessibility-tree", "root")
Expand Down
3 changes: 1 addition & 2 deletions tools/arch/PKGBUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ build() {
--disable-dependency-tracking \
--disable-silent-rules \
--with-cockpit-user=cockpit-ws \
--with-cockpit-ws-instance-user=cockpit-wsinstance \
--enable-pybridge
--with-cockpit-ws-instance-user=cockpit-wsinstance

make all
}
Expand Down
19 changes: 8 additions & 11 deletions tools/cockpit.spec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,9 @@ Version: 0
Release: 1%{?dist}
Source0: https://github.com/cockpit-project/cockpit/releases/download/%{version}/cockpit-%{version}.tar.xz

%if 0%{?fedora} >= 38 || 0%{?rhel} >= 9
%define cockpit_enable_python 1
%endif

%if !%{defined cockpit_enable_python}
%define cockpit_enable_python 0
# Don't change the bridge in the RHEL 8; the old SSH breaks some features, see @todoPybridgeRHEL8
%if 0%{?rhel} == 8
%define enable_old_bridge 1
%endif

# in RHEL 8 the source package is duplicated: cockpit (building basic packages like cockpit-{bridge,system})
Expand Down Expand Up @@ -170,7 +167,7 @@ Suggests: cockpit-selinux
Requires: subscription-manager-cockpit
%endif

%if %{cockpit_enable_python}
%if 0%{?enable_old_bridge} == 0
BuildRequires: python3-devel
BuildRequires: python3-pip
%if 0%{?rhel} == 0
Expand All @@ -196,8 +193,8 @@ BuildRequires: python3-tox-current-env
--docdir=%_defaultdocdir/%{name} \
%endif
--with-pamdir='%{pamdir}' \
%if %{cockpit_enable_python}
--enable-pybridge \
%if 0%{?enable_old_bridge}
--enable-old-bridge \
%endif
%if 0%{?build_basic} == 0
--disable-ssh \
Expand All @@ -208,7 +205,7 @@ BuildRequires: python3-tox-current-env
%check
make -j$(nproc) check

%if %{cockpit_enable_python} && 0%{?rhel} == 0
%if 0%{?enable_old_bridge} == 0 && 0%{?rhel} == 0
%tox
%endif

Expand Down Expand Up @@ -374,7 +371,7 @@ system on behalf of the web based user interface.
%doc %{_mandir}/man1/cockpit-bridge.1.gz
%{_bindir}/cockpit-bridge
%{_libexecdir}/cockpit-askpass
%if %{cockpit_enable_python}
%if 0%{?enable_old_bridge} == 0
%{python3_sitelib}/%{name}*
%{_libexecdir}/cockpit-beiboot
%endif
Expand Down
24 changes: 10 additions & 14 deletions tools/debian/rules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH)

# Keep the older C bridge on stable releases
C_BRIDGE = $(filter $(shell . /etc/os-release; echo $${VERSION_ID:-unstable}),11 12 22.04)
ifeq ($(C_BRIDGE),)
CONFIG_OPTIONS += --enable-pybridge
OLD_BRIDGE = $(filter $(shell . /etc/os-release; echo $${VERSION_ID:-unstable}),11 12 22.04)
ifneq ($(OLD_BRIDGE),)
CONFIG_OPTIONS += --enable-old-bridge
endif

# riscv is an emulated architecture for now, and too slow to run expensive unit tests
Expand All @@ -25,14 +25,10 @@ override_dh_auto_configure:
--with-pamdir=/lib/$(DEB_HOST_MULTIARCH)/security \
--libexecdir=/usr/lib/cockpit $(CONFIG_OPTIONS)

# HACK: Debian's pip breaks --prefix: https://bugs.debian.org/1035546
# redirect /usr/local to /usr, as merging the trees after install is brittle
execute_before_dh_auto_install:
mkdir -p debian/tmp/usr; ln -s . debian/tmp/usr/local

# undo the pip hack
execute_after_dh_auto_install:
rm debian/tmp/usr/local
# HACK: Debian's pip breaks --prefix: https://bugs.debian.org/1035546 with
# default install layout
override_dh_auto_install:
DEB_PYTHON_INSTALL_LAYOUT=deb dh_auto_install
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thanks.


# avoid trying to start cockpit-motd.service and cockpit-wsinstance-*.socket etc.
override_dh_installsystemd:
Expand All @@ -57,7 +53,7 @@ override_dh_install:
rm debian/tmp/usr/share/metainfo/org.cockpit-project.cockpit-selinux.metainfo.xml

dh_install -Xusr/src/debug
ifeq ($(C_BRIDGE),)
ifeq ($(OLD_BRIDGE),)
# we don't need this, it contains full build paths and breaks reproducibility
rm -r debian/tmp/usr/lib/python*/*-packages/*.dist-info
dh_install -p cockpit-bridge debian/tmp/usr/lib/python*
Expand All @@ -68,14 +64,14 @@ endif

execute_after_dh_install-indep:
# avoid dh_missing failure
ifeq ($(C_BRIDGE),)
ifeq ($(OLD_BRIDGE),)
rm -r debian/tmp/usr/lib/python* debian/tmp/usr/lib/cockpit/cockpit-beiboot
endif

# run pytests *after* installation, so that we can make sure that we installed the right files
execute_after_dh_install-arch:
ifeq (, $(findstring nocheck, $(DEB_BUILD_OPTIONS)))
ifeq ($(C_BRIDGE),)
ifeq ($(OLD_BRIDGE),)
pytest -vv -k 'not linter and not test_descriptions' -opythonpath=$$(ls -d debian/cockpit-bridge/usr/lib/python3*/dist-packages)
endif
endif
Loading