Set RABBITMQ_PLUGINS_DIR when starting the server #273

akaihola · 2022-02-07T20:27:24Z

Only RABBITMQ_ENABLED_PLUGINS_FILE was being set, but and any .ez files in the directory specified using the --rabbitmq-plugindir Pytest option would be ignored.

akaihola · 2022-02-08T13:12:06Z

@fizyk, tests seem to fail. Could it be that some of the integration tests point to a plugins directory which isn't actually valid for RabbitMQ?

fizyk · 2022-02-08T21:27:49Z

@akaihola by default it points to the tempdir, maybe that's why. It's fine to have there a temporary plugin's file, but ni plugin directory (with some random stuff possibly)
https://github.com/ClearcodeHQ/pytest-rabbitmq/blob/main/src/pytest_rabbitmq/plugin.py#L57

akaihola · 2022-02-10T06:42:25Z

So creating an empty directory (e.g. with tempfile.TemporaryDirectory()) would probably be more appropriate?

fizyk · 2022-02-10T09:56:14Z

@akaihola yes, I think so, so the default should be a new temporary directory within tempdir, rather than tmpdir itself.

akaihola · 2022-04-22T04:20:17Z

The tests do pass if I run them locally in a container. Any idea what is different in the GitHub Workflows environment?

I'm using this Dockerfile with Podman:

FROM python

RUN apt-get update \
 && apt-get install -y rabbitmq-server \
 && rm -rf /var/lib/apt/lists/*
COPY . /pytest-rabbitmq
WORKDIR /pytest-rabbitmq
RUN python -m pip install --upgrade pip
RUN pip install -r requirements-test.txt
CMD pytest -n 0 --cov-report=xml \
 && pytest -n 1 --cov-report=xml:coverage-xdist.xml

And it indeed runs fine:

$ podman run pytest-rabbitmq
============================= test session starts ==============================
platform linux -- Python 3.8.12, pytest-7.0.0, pluggy-1.0.0 -- /usr/local/bin/python
cachedir: .pytest_cache
rootdir: /pytest-rabbitmq, configfile: setup.cfg, testpaths: tests
plugins: forked-1.4.0, xdist-2.5.0, cov-3.0.0, rabbitmq-2.2.0
collecting ... collected 7 items

tests/test_rabbitmq.py::test_rabbitmq PASSED                             [ 14%]
tests/test_rabbitmq.py::test_second_rabbitmq PASSED                      [ 28%]
tests/test_rabbitmq.py::test_rabbitmq_clear_exchanges PASSED             [ 42%]
tests/test_rabbitmq.py::test_rabbitmq_clear_queues PASSED                [ 57%]
tests/test_rabbitmq.py::test_random_port PASSED                          [ 71%]
tests/test_rabbitmq.py::test_random_port_node_names PASSED               [ 85%]
tests/test_rabbitmq.py::test_plugin_directory PASSED                     [100%]

---------- coverage: platform linux, python 3.8.12-final-0 -----------
Coverage XML written to file coverage.xml


============================== 7 passed in 51.57s ==============================
/usr/local/lib/python3.8/site-packages/coverage/inorout.py:535: CoverageWarning: Module pytest_rabbitmq was previously imported, but not measured (module-not-measured)
  self.warn(msg, slug="module-not-measured")
============================= test session starts ==============================
platform linux -- Python 3.8.12, pytest-7.0.0, pluggy-1.0.0 -- /usr/local/bin/python
cachedir: .pytest_cache
rootdir: /pytest-rabbitmq, configfile: setup.cfg, testpaths: tests
plugins: forked-1.4.0, xdist-2.5.0, cov-3.0.0, rabbitmq-2.2.0
gw0 I
[gw0] linux Python 3.8.12 cwd: /pytest-rabbitmq
[gw0] Python 3.8.12 (default, Mar  2 2022, 05:04:35)  -- [GCC 10.2.1 20210110]
gw0 [7]

scheduling tests via LoadScheduling

tests/test_rabbitmq.py::test_rabbitmq 
[gw0] [ 14%] PASSED tests/test_rabbitmq.py::test_rabbitmq 
tests/test_rabbitmq.py::test_second_rabbitmq 
[gw0] [ 28%] PASSED tests/test_rabbitmq.py::test_second_rabbitmq 
tests/test_rabbitmq.py::test_rabbitmq_clear_exchanges 
[gw0] [ 42%] PASSED tests/test_rabbitmq.py::test_rabbitmq_clear_exchanges 
tests/test_rabbitmq.py::test_rabbitmq_clear_queues 
[gw0] [ 57%] PASSED tests/test_rabbitmq.py::test_rabbitmq_clear_queues 
tests/test_rabbitmq.py::test_random_port 
[gw0] [ 71%] PASSED tests/test_rabbitmq.py::test_random_port 
tests/test_rabbitmq.py::test_random_port_node_names 
[gw0] [ 85%] PASSED tests/test_rabbitmq.py::test_random_port_node_names 
tests/test_rabbitmq.py::test_plugin_directory 
[gw0] [100%] PASSED tests/test_rabbitmq.py::test_plugin_directory /usr/local/lib/python3.8/site-packages/coverage/inorout.py:535: CoverageWarning: Module pytest_rabbitmq was previously imported, but not measured (module-not-measured)
  self.warn(msg, slug="module-not-measured")


---------- coverage: platform linux, python 3.8.12-final-0 -----------
Coverage XML written to file coverage-xdist.xml


============================== 7 passed in 44.34s ==============================

fizyk · 2022-04-22T12:36:13Z

@akaihola looking at this I think the difference is the lack of administrative privileges.

your local run on docker is being run with root, so it does have all privileges. The github actions run is used with a user without those privileges, and maybe the plugin_path is restricted, or it's creation would require root privileges 🤔
https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#administrative-privileges-of-github-hosted-runners

akaihola · 2022-04-22T19:27:55Z

Thanks @fizyk, I trust you that the lack of admin privileges is indeed the culprit here.

I couldn't find a pre-built Docker image which would claim to be close to GitHub's ubuntu-latest. I would have liked to reproduce and fix the failure locally. Any idea how to do that?

fizyk · 2022-04-25T07:41:11Z

You have to create separate user on your docker, and switch to it prior to requirements installation and run:

https://docs.docker.com/engine/reference/builder/#user

akaihola · 2022-04-26T19:00:25Z

@fizyk, I tried with this Dockerfile, but all tests still pass:

FROM python

RUN apt-get update \
 && apt-get install -y rabbitmq-server \
 && rm -rf /var/lib/apt/lists/*
COPY src /pytest-rabbitmq/src
COPY tests /pytest-rabbitmq/tests
COPY setup.* /pytest-rabbitmq/
COPY requirements-test.txt /pytest-rabbitmq/
WORKDIR /pytest-rabbitmq
RUN useradd -m pyuser \
 && chown -R pyuser /pytest-rabbitmq
USER pyuser
ENV PATH /home/pyuser/.local/bin:$PATH
RUN python -m pip install --upgrade pip
RUN pip install -r requirements-test.txt
CMD pytest -n 0 --cov-report=xml \
 && pytest -n 1 --cov-report=xml:coverage-xdist.xml

fizyk · 2022-04-28T16:23:19Z

@akaihola do you have a branch I could look at when I'll have spare time?
I have somewhat similar problem with running tests on github actions in pytest-elasticsearch with elasticsearch 8, where tests locally pass just fine, but I can not connect to it properly on github-actions 😕

akaihola · 2022-04-28T18:56:36Z

@fizyk, I'm using the very branch of this pull request (akaihola:plugin-dir) with the Dockerfile I pasted above.

fizyk

I've merged main branch and added additional commit removing the default value, however after a bit of thinking I believe there's no real need for default, the default, should be not to use these settings. And only use them if someone will pass the configuration options.

fizyk · 2022-04-30T21:26:31Z

src/pytest_rabbitmq/factories/executor.py

@@ -37,7 +37,8 @@ def __init__(
        envvars = {
            "RABBITMQ_LOG_BASE": logpath + f"/rabbit-server.{port}.log",
            "RABBITMQ_MNESIA_BASE": path + "mnesia",
-            "RABBITMQ_ENABLED_PLUGINS_FILE": plugin_path + "/plugins",
+            "RABBITMQ_ENABLED_PLUGINS_FILE": plugin_path + "/enabled",
+            "RABBITMQ_PLUGINS_DIR": plugin_path,


🤔 maybe skip both settings if the plugin's dir does not exists? question, what happens if we'll point to the real files and paths, will it work?

my thinking is that there's not much point to point to the default for both of these settings (enabled_plugin_file and plugins_dir) if they are not existing.

fizyk · 2022-04-30T21:30:10Z

src/pytest_rabbitmq/factories/process.py

@@ -96,7 +96,7 @@ def rabbitmq_proc_fixture(request):
        rabbit_port = get_port(port) or get_port(config["port"])

        rabbit_path = os.path.join(gettempdir(), f"rabbitmq.{rabbit_port}/")
-        rabbit_plugin_path = plugindir or config["plugindir"] or rabbit_path
+        rabbit_plugin_path = plugindir or config["plugindir"] or os.path.join(rabbit_path, "plugins")


changed the default to None, and pointed to plugins inside the created rabbit_path as created above. However I believe it should no have default

akaihola · 2022-05-03T18:30:06Z

It seems /usr/lib/rabbitmq/bin/rabbitmq-server is now crashing in multiple tests with

init terminating in do_boot
({undef,
  [{rabbit_nodes_common,make,test3,[]},
   {rabbit_prelaunch,start,0,[{_},{_}]},
   {init,start_em,1,[]},
   {init,do_boot,3,[]}]
})

Crash dump is being written to: /tmp/rabbit-server.28723.log/erl_crash.dump...

This goes way beyond my expertise unfortunately.

fizyk · 2022-05-23T14:22:22Z

As most of the Java programs when they crash for me. I won't promise when, but I'll take a look at it someday...

akaihola · 2022-05-26T20:31:58Z

As most of the Java programs when they crash for me. I won't promise when, but I'll take a look at it someday...

Although RabbitMQ isn't written in Java but in Erlang.

akaihola force-pushed the plugin-dir branch from 34154ed to a38fc52 Compare February 7, 2022 20:31

Set RABBITMQ_PLUGINS_DIR when starting the server

ab940ae

akaihola force-pushed the plugin-dir branch from a38fc52 to ab940ae Compare February 7, 2022 20:34

fizyk approved these changes Feb 8, 2022

View reviewed changes

fizyk added 2 commits April 30, 2022 22:59

Merge branch 'main' into plugin-dir

b8baeb1

Attempt to use subfolders within temporary directory for plugins

4127f7e

fizyk force-pushed the plugin-dir branch from 02f65fb to 4127f7e Compare April 30, 2022 21:00

fizyk requested changes Apr 30, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set RABBITMQ_PLUGINS_DIR when starting the server #273

Set RABBITMQ_PLUGINS_DIR when starting the server #273

akaihola commented Feb 7, 2022

akaihola commented Feb 8, 2022

fizyk commented Feb 8, 2022

akaihola commented Feb 10, 2022 •

edited

Loading

fizyk commented Feb 10, 2022

akaihola commented Apr 22, 2022

fizyk commented Apr 22, 2022

akaihola commented Apr 22, 2022

fizyk commented Apr 25, 2022

akaihola commented Apr 26, 2022

fizyk commented Apr 28, 2022

akaihola commented Apr 28, 2022

fizyk left a comment

fizyk Apr 30, 2022

fizyk Apr 30, 2022

fizyk Apr 30, 2022

akaihola commented May 3, 2022

fizyk commented May 23, 2022

akaihola commented May 26, 2022

Set RABBITMQ_PLUGINS_DIR when starting the server #273

Are you sure you want to change the base?

Set RABBITMQ_PLUGINS_DIR when starting the server #273

Conversation

akaihola commented Feb 7, 2022

akaihola commented Feb 8, 2022

fizyk commented Feb 8, 2022

akaihola commented Feb 10, 2022 • edited Loading

fizyk commented Feb 10, 2022

akaihola commented Apr 22, 2022

fizyk commented Apr 22, 2022

akaihola commented Apr 22, 2022

fizyk commented Apr 25, 2022

akaihola commented Apr 26, 2022

fizyk commented Apr 28, 2022

akaihola commented Apr 28, 2022

fizyk left a comment

Choose a reason for hiding this comment

fizyk Apr 30, 2022

Choose a reason for hiding this comment

fizyk Apr 30, 2022

Choose a reason for hiding this comment

fizyk Apr 30, 2022

Choose a reason for hiding this comment

akaihola commented May 3, 2022

fizyk commented May 23, 2022

akaihola commented May 26, 2022

akaihola commented Feb 10, 2022 •

edited

Loading