Merge 9d2969a into 29ec5bf

processone · Jan 17, 2024 · 77cb918 · 77cb918
2 parents 29ec5bf + 9d2969a
commit 77cb918
Show file tree

Hide file tree

Showing 20 changed files with 562 additions and 126 deletions.
diff --git a/.github/container/ejabberdctl.template b/.github/container/ejabberdctl.template
@@ -187,8 +187,8 @@ livewarning()
         echo "Please be extremely cautious with your actions,"
         echo "and exit immediately if you are not completely sure."
         echo ""
-        echo "To exit this LIVE mode and stop ejabberd, press:"
-        echo "  q().  and press the Enter key"
+        echo "To exit and detach this shell from ejabberd, press:"
+        echo "  control+g and then q"
         echo ""
         echo "--------------------------------------------------------------------"
         echo "To bypass permanently this warning, add to ejabberdctl.cfg the line:"

diff --git a/.github/workflows/runtime.yml b/.github/workflows/runtime.yml
@@ -44,6 +44,16 @@ jobs:
 
     - uses: actions/checkout@v4
 
+    - name: Get compatible Rebar binaries
+      if: matrix.otp < 23
+      run: |
+        rm rebar
+        rm rebar3
+        wget https://github.com/processone/ejabberd/raw/21.12/rebar
+        wget https://github.com/processone/ejabberd/raw/21.12/rebar3
+        chmod +x rebar
+        chmod +x rebar3
+
     - name: Prepare libraries
       run: |
         apt-get -qq update
@@ -54,10 +64,11 @@ jobs:
     - name: Compile
       run: |
         ./autogen.sh
-        ./configure --with-rebar=`which ${{ matrix.rebar }}` \
+        ./configure --with-rebar=${{ matrix.rebar }} \
                     --prefix=/tmp/ejabberd \
                     --enable-all \
                     --disable-elixir \
+                    --disable-tools \
                     --disable-odbc
         make update
         make
@@ -71,61 +82,216 @@ jobs:
         rel/ejabberd/bin/ejabberdctl start \
           && rel/ejabberd/bin/ejabberdctl started
         rel/ejabberd/bin/ejabberdctl register user1 localhost s0mePass
-        rel/ejabberd/bin/ejabberdctl registered_users localhost
+        rel/ejabberd/bin/ejabberdctl register user2 localhost s0mePass
+        rel/ejabberd/bin/ejabberdctl registered_users localhost > registered.log
         cat rel/ejabberd/logs/*
 
-    - name: Test rel
+    - name: Run rel
       if: matrix.rebar != 'rebar'
       run: |
         make rel
         _build/prod/rel/ejabberd/bin/ejabberdctl start \
           && _build/prod/rel/ejabberd/bin/ejabberdctl started
         _build/prod/rel/ejabberd/bin/ejabberdctl register user1 localhost s0mePass
-        _build/prod/rel/ejabberd/bin/ejabberdctl registered_users localhost
+        _build/prod/rel/ejabberd/bin/ejabberdctl registered_users localhost > registered.log
         _build/prod/rel/ejabberd/bin/ejabberdctl stop \
           && _build/prod/rel/ejabberd/bin/ejabberdctl stopped
+
+    - name: Run dev
+      if: matrix.rebar != 'rebar'
+      run: |
+        make dev
+        _build/dev/rel/ejabberd/bin/ejabberdctl start \
+          && _build/dev/rel/ejabberd/bin/ejabberdctl started
+        _build/dev/rel/ejabberd/bin/ejabberdctl register user2 localhost s0mePass
+        _build/dev/rel/ejabberd/bin/ejabberdctl registered_users localhost >> registered.log
+        _build/dev/rel/ejabberd/bin/ejabberdctl stop \
+          && _build/dev/rel/ejabberd/bin/ejabberdctl stopped
+
+    - name: Run install
+      if: matrix.rebar != 'rebar'
+      run: |
+        make install
+        /tmp/ejabberd/sbin/ejabberdctl start \
+          && /tmp/ejabberd/sbin/ejabberdctl started
+        /tmp/ejabberd/sbin/ejabberdctl register user3 localhost s0mePass
+        /tmp/ejabberd/sbin/ejabberdctl registered_users localhost >> registered.log
+        /tmp/ejabberd/sbin/ejabberdctl stop \
+          && /tmp/ejabberd/sbin/ejabberdctl stopped
+
+    - name: View logs
+      if: matrix.rebar != 'rebar'
+      run: |
+        echo "===> Registered:"
+        cat registered.log
+        echo "===> Prod:"
         cat _build/prod/rel/ejabberd/logs/*
+        echo "===> Dev:"
+        cat _build/dev/rel/ejabberd/logs/*
+        echo "===> Install:"
+        cat /tmp/ejabberd/var/log/ejabberd/*
 
-    - name: Test dev
+    - name: Check logs
       if: matrix.rebar != 'rebar'
+      run: |
+        grep -q '^user1$' registered.log
+        grep -q '^user2$' registered.log
+        grep -q '^user3$' registered.log
+        grep -q 'is started' _build/prod/rel/ejabberd/logs/ejabberd.log
+        grep -q 'is stopped' _build/prod/rel/ejabberd/logs/ejabberd.log
+        test $(find _build/prod/ -empty -name error.log)
+        grep -q 'is started' _build/dev/rel/ejabberd/logs/ejabberd.log
+        grep -q 'is stopped' _build/dev/rel/ejabberd/logs/ejabberd.log
+        test $(find _build/dev/ -empty -name error.log)
+        grep -q 'is started' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        grep -q 'is stopped' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        test $(find /tmp/ejabberd/var/log/ejabberd/ -empty -name error.log)
+
+    - name: View logs failures
+      if: matrix.rebar != 'rebar'
+      run: |
+        cat _build/prod/rel/ejabberd/logs/ejabberd.log
+        cat _build/prod/rel/ejabberd/logs/error.log
+        cat _build/dev/rel/ejabberd/logs/ejabberd.log
+        cat _build/dev/rel/ejabberd/logs/error.log
+        cat /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        cat /tmp/ejabberd/var/log/ejabberd/error.log
+
+  rebar3-elixir:
+    name: Rebar3+Elixir
+    strategy:
+      fail-fast: false
+      matrix:
+        otp: ['23.0', '25.3', '26']
+        elixir: ['1.13.4', '1.15.7', '1.16']
+        exclude:
+        - otp: '23.0'
+          elixir: '1.15.7'
+        - otp: '23.0'
+          elixir: '1.16'
+        - otp: '26'
+          elixir: '1.13.4'
+    runs-on: ubuntu-20.04
+
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - name: Get specific Erlang/OTP
+      uses: erlef/setup-beam@v1
+      with:
+        otp-version: ${{matrix.otp}}
+        elixir-version: ${{matrix.elixir}}
+
+    - name: Prepare libraries
+      run: |
+        sudo apt-get -qq update
+        sudo apt-get -y purge libgd3 nginx
+        sudo apt-get -qq install libexpat1-dev libgd-dev libpam0g-dev \
+                                 libsqlite3-dev libwebp-dev libyaml-dev
+
+    - name: Enable ModPresenceDemo and an Elixir dependency
+      run: |
+        sed -i "s|^modules:|modules:\n  'ModPresenceDemo': {}|g" ejabberd.yml.example
+        cat ejabberd.yml.example
+        sed -i 's|^{deps, \(.*\)|{deps, \1\n  {decimal, ".*", {git, "https://github.com/ericmj/decimal", {branch, "main"}}}, |g' rebar.config
+        cat rebar.config
+
+    - name: Compile
+      run: |
+        ./autogen.sh
+        ./configure --with-rebar=rebar3 \
+                    --prefix=/tmp/ejabberd \
+                    --enable-all \
+                    --disable-odbc
+        make update
+        make
+
+    - run: make xref
+
+    - name: Run rel
+      run: |
+        make rel
+        _build/prod/rel/ejabberd/bin/ejabberdctl start \
+          && _build/prod/rel/ejabberd/bin/ejabberdctl started
+        _build/prod/rel/ejabberd/bin/ejabberdctl register user1 localhost s0mePass
+        _build/prod/rel/ejabberd/bin/ejabberdctl registered_users localhost > registered.log
+        _build/prod/rel/ejabberd/bin/ejabberdctl stop \
+          && _build/prod/rel/ejabberd/bin/ejabberdctl stopped
+
+    - name: Run dev
       run: |
         make dev
         _build/dev/rel/ejabberd/bin/ejabberdctl start \
           && _build/dev/rel/ejabberd/bin/ejabberdctl started
-        _build/dev/rel/ejabberd/bin/ejabberdctl register user1 localhost s0mePass
-        _build/dev/rel/ejabberd/bin/ejabberdctl registered_users localhost
+        _build/dev/rel/ejabberd/bin/ejabberdctl register user2 localhost s0mePass
+        _build/dev/rel/ejabberd/bin/ejabberdctl registered_users localhost >> registered.log
         _build/dev/rel/ejabberd/bin/ejabberdctl stop \
           && _build/dev/rel/ejabberd/bin/ejabberdctl stopped
+
+    - name: Run install
+      run: |
+        make install
+        /tmp/ejabberd/sbin/ejabberdctl start \
+          && /tmp/ejabberd/sbin/ejabberdctl started
+        /tmp/ejabberd/sbin/ejabberdctl register user3 localhost s0mePass
+        /tmp/ejabberd/sbin/ejabberdctl registered_users localhost >> registered.log
+        /tmp/ejabberd/sbin/ejabberdctl stop \
+          && /tmp/ejabberd/sbin/ejabberdctl stopped
+
+    - name: View logs
+      if: always()
+      run: |
+        echo "===> Registered:"
+        cat registered.log
+        echo "===> Prod:"
+        cat _build/prod/rel/ejabberd/logs/*
+        echo "===> Dev:"
         cat _build/dev/rel/ejabberd/logs/*
+        echo "===> Install:"
+        cat /tmp/ejabberd/var/log/ejabberd/*
+
+    - name: Check logs
+      if: always()
+      run: |
+        grep -q '^user1$' registered.log
+        grep -q '^user2$' registered.log
+        grep -q '^user3$' registered.log
+        grep -q 'is started' _build/prod/rel/ejabberd/logs/ejabberd.log
+        grep -q 'is stopped' _build/prod/rel/ejabberd/logs/ejabberd.log
+        grep -q 'module Presence Demo' _build/prod/rel/ejabberd/logs/ejabberd.log
+        test $(find _build/prod/ -empty -name error.log)
+        grep -q 'is started' _build/dev/rel/ejabberd/logs/ejabberd.log
+        grep -q 'is stopped' _build/dev/rel/ejabberd/logs/ejabberd.log
+        grep -q 'module Presence Demo' _build/dev/rel/ejabberd/logs/ejabberd.log
+        test $(find _build/dev/ -empty -name error.log)
+        grep -q 'is started' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        grep -q 'is stopped' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        grep -q 'module Presence Demo' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        test $(find /tmp/ejabberd/var/log/ejabberd/ -empty -name error.log)
+
+    - name: View logs failures
+      if: failure()
+      run: |
+        cat _build/prod/rel/ejabberd/logs/ejabberd.log
+        cat _build/prod/rel/ejabberd/logs/error.log
+        cat _build/dev/rel/ejabberd/logs/ejabberd.log
+        cat _build/dev/rel/ejabberd/logs/error.log
+        cat /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        cat /tmp/ejabberd/var/log/ejabberd/error.log
 
   mix:
     name: Mix
     strategy:
       fail-fast: false
       matrix:
-        otp: ['21.3', '25.0', '26']
-        elixir: ['1.10.3', '1.11.4', '1.12.3', '1.13.4', '1.14.5', '1.15']
+        otp: ['23.0', '25.3', '26']
+        elixir: ['1.13.4', '1.15.7', '1.16']
         exclude:
-        - otp: '21.3'
-          elixir: '1.12.3'
-        - otp: '21.3'
-          elixir: '1.13.4'
-        - otp: '21.3'
-          elixir: '1.14.5'
-        - otp: '21.3'
-          elixir: '1.15'
-        - otp: '25.0'
-          elixir: '1.10.3'
-        - otp: '25.0'
-          elixir: '1.11.4'
-        - otp: '25.0'
-          elixir: '1.12.3'
-        - otp: '26'
-          elixir: '1.10.3'
-        - otp: '26'
-          elixir: '1.11.4'
-        - otp: '26'
-          elixir: '1.12.3'
+        - otp: '23.0'
+          elixir: '1.15.7'
+        - otp: '23.0'
+          elixir: '1.16'
         - otp: '26'
           elixir: '1.13.4'
     runs-on: ubuntu-20.04
@@ -155,13 +321,19 @@ jobs:
         echo "::remove-matcher owner=elixir-mixTestFailure::"
         echo "::remove-matcher owner=elixir-dialyzerOutputDefault::"
 
+    - name: Enable ModPresenceDemo and an Elixir dependency
+      run: |
+        sed -i "s|^modules:|modules:\n  'ModPresenceDemo': {}|g" ejabberd.yml.example
+        cat ejabberd.yml.example
+        sed -i 's|^{deps, \(.*\)|{deps, \1\n  {decimal, ".*", {git, "https://github.com/ericmj/decimal", {branch, "main"}}}, |g' rebar.config
+        cat rebar.config
+
     - name: Compile
       run: |
         ./autogen.sh
         ./configure --with-rebar=mix \
                     --prefix=/tmp/ejabberd \
                     --enable-all \
-                    --disable-elixir \
                     --disable-odbc
         mix deps.get
         make
@@ -188,17 +360,46 @@ jobs:
         _build/dev/rel/ejabberd/bin/ejabberdctl stop \
           && _build/dev/rel/ejabberd/bin/ejabberdctl stopped
 
-    - name: Check rel
+    - name: Run install
+      run: |
+        make install
+        /tmp/ejabberd/sbin/ejabberdctl start \
+          && /tmp/ejabberd/sbin/ejabberdctl started
+        /tmp/ejabberd/sbin/ejabberdctl register user3 localhost s0mePass
+        /tmp/ejabberd/sbin/ejabberdctl registered_users localhost >> registered.log
+        /tmp/ejabberd/sbin/ejabberdctl stop \
+          && /tmp/ejabberd/sbin/ejabberdctl stopped
+
+    - name: View logs
+      if: always()
+      run: |
+        echo "===> Registered:"
+        cat registered.log
+        echo "===> Prod:"
+        cat _build/prod/rel/ejabberd/logs/*
+        echo "===> Dev:"
+        cat _build/dev/rel/ejabberd/logs/*
+        echo "===> Install:"
+        cat /tmp/ejabberd/var/log/ejabberd/*
+
+    - name: Check logs
       if: always()
       run: |
         grep -q '^user1$' registered.log
         grep -q '^user2$' registered.log
+        grep -q '^user3$' registered.log
         grep -q 'is started' _build/prod/rel/ejabberd/logs/ejabberd.log
         grep -q 'is stopped' _build/prod/rel/ejabberd/logs/ejabberd.log
+        grep -q 'module Presence Demo' _build/prod/rel/ejabberd/logs/ejabberd.log
         test $(find _build/prod/ -empty -name error.log)
         grep -q 'is started' _build/dev/rel/ejabberd/logs/ejabberd.log
         grep -q 'is stopped' _build/dev/rel/ejabberd/logs/ejabberd.log
+        grep -q 'module Presence Demo' _build/dev/rel/ejabberd/logs/ejabberd.log
         test $(find _build/dev/ -empty -name error.log)
+        grep -q 'is started' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        grep -q 'is stopped' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        grep -q 'module Presence Demo' /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        test $(find /tmp/ejabberd/var/log/ejabberd/ -empty -name error.log)
 
     - name: View logs failures
       if: failure()
@@ -207,3 +408,5 @@ jobs:
         cat _build/prod/rel/ejabberd/logs/error.log
         cat _build/dev/rel/ejabberd/logs/ejabberd.log
         cat _build/dev/rel/ejabberd/logs/error.log
+        cat /tmp/ejabberd/var/log/ejabberd/ejabberd.log
+        cat /tmp/ejabberd/var/log/ejabberd/error.log
diff --git a/COMPILE.md b/COMPILE.md
@@ -28,7 +28,8 @@ Other optional libraries are:
 - PAM library, for Pluggable Authentication Modules (PAM)
 - ImageMagick's Convert program and Ghostscript fonts, for CAPTCHA
   challenges
-- Elixir ≥ 1.10.3, to support Elixir, and alternative to rebar/rebar3
+- Elixir ≥ 1.10.3, for Elixir support. It is recommended Elixir 1.13.4 or higher
+  and Erlang/OTP 23.0 or higher.
 
 If your system splits packages in libraries and development headers,
 install the development packages too.
@@ -89,7 +90,7 @@ Build an OTP Release
 Instead of installing ejabberd in the system, you can build an OTP release
 that includes all necessary to run ejabberd in a subdirectory:
 
-    ./configure --with-rebar=rebar3
+    ./configure
     make rel
 
 Or, if you have Elixir available and plan to develop Elixir code: