Merge branch 'stable-6.0' into bugfix/nonblocking_socket

Author: CamJN

CHANGELOG

@@ -5,6 +5,21 @@ Release 6.0.27 (Not yet released)
  * [Ruby] Fix compatibility with Rack 2 While maintaining compatibility with Rack 3. Closes GH-2595.
  * [Ruby] Use non-deprecated functions in native extensions.
  * Fix an issue where Passenger could freeze while connecting to application processes (event loop blocking).
+ * Updated various library versions used in precompiled binaries (used for e.g. gem installs):
+   - ccache: 4.10.2 -> 4.11.2
+   - cmake: 3.31.3 -> 3.31.6
+   - curl: 8.11.1 -> 8.12.1
+   - git: 2.47.1 -> 2.49.0
+   - libassuan: 3.0.1 -> 3.0.2
+   - libffi: 3.4.6 -> 3.4.7
+   - openssl: 3.4.0 -> 3.4.1
+   - pcre2: 10.44 -> 10.45
+   - rubies
+     - 3.2.6 -> 3.2.7
+     - 3.3.6 -> 3.3.7
+     - 3.4.1 -> 3.4.2
+   - rubygems: 3.6.2 -> 3.6.6
+   - zstd: 1.5.6 -> 1.5.7
  * 
 
 

CONTRIBUTING.md

@@ -140,9 +140,9 @@ The `test:cxx` unit test suite contains many different test groups. You can run
 
     rake test:cxx GROUPS='ApplicationPool2_PoolTest,UtilsTest'
 
-You can also run just a single test within a suite. Pass the relevant test number like this:
+You can also run specific tests within a suite. Pass the relevant test number(s) like this:
 
-    rake test:cxx GROUPS='ApplicationPool2_PoolTest:82'
+    rake test:cxx GROUPS='ApplicationPool2_PoolTest:82,83'
 
 You can also run the C++ tests in GDB or Valgrind. We have a useful GDB config file in `test/gdbinit.example`. You should copy it to `test/.gdbinit` and edit it.
 

doc/CxxTestingGuide.md

@@ -0,0 +1,110 @@
+# C++ testing guide
+
+C++ tests use a modified version of the [Tut test framework](https://mrzechonek.github.io/tut-framework/).
+
+Test files are placed in test/cxx/SomethingTest.cpp.
+
+## Test suite example
+
+```c++
+#include <TestSupport.h> // Always include this
+#include <Something.h> // The class to test
+
+// Always use these namespaces
+using namespace std;
+using namespace boost;
+using namespace Passenger;
+
+namespace tut {
+    // Each test suite has a corresponding context struct, created and
+    // deleted for every test case. You can put test case-local state here.
+    struct SomethingTest: public TestBase {
+        Something something;
+    };
+
+    TEST_METHOD(1) {
+        set_test_name("Description for test 1");
+
+        // Test logic here.
+        // `this` is a SomethingTest instance.
+
+        ensure_equals("Description for assertion 1", 1, something.foo());
+        ensure_equals("Description for assertion 2", 2, something.bar());
+    }
+
+    TEST_METHOD(2) {
+        set_test_name("Description for test 2");
+
+        // Test logic here.
+        // `this` is a SomethingTest instance.
+    }
+}
+```
+
+## Available assertions
+
+ - `ensure([description,] bool)` — Asserts argument is true.
+ - `ensure_not([description,] bool)`
+ - `ensure_equals([description,] actual, expected)` — Asserts `actual == expected`.
+ - `ensure_not_equals([description,] actual, expected)`
+ - `ensure_gt(description, a, b)` — Asserts `a > b`.
+ - `ensure_distance([description,] a, b, d)` — Asserts the distance between `a` and `b` is <= `d`.
+ - `fail(description)` — Fails the test case.
+
+### Special assertions for multithreaded code
+
+ - `EVENTUALLY(deadlineSeconds, code)` — Asserts that "something eventually happens".
+
+   Runs `code` in a loop, sleeping for 10 msec each time, until code set `result = true` or timeout.
+
+   Example:
+
+   ```c++
+   EVENTUALLY(5,
+     result = fileExists("foo.txt");
+   );
+   ```
+
+   Notes:
+
+    - `code` is in a new lexical context, so defining variables there is fine.
+    - Since EVENTUALLY is for multithreaded use cases, remember to synchronize access to shared state.
+
+- `EVENTUALLY2(deadlineMsec, sleeptimeMsec, code)` — Same as EVENTUALLY but with finer timing customization.
+
+- `SHOULD_NEVER_HAPPEN(deadlineMsec, code)` — Asserts that "something should never happen".
+
+  Runs `code` in a loop for `deadlineMsec`. If `code` sets `result = true`, the test fails.
+
+  Example:
+
+  ```c++
+  SHOULD_NEVER_HAPPEN(1000,
+    result = checkSocketDisconnected();
+  );
+  ```
+
+  The notes for `EVENTUALLY()` also apply here.
+
+## Mocking
+
+See [C++ mocking strategy](CxxMockingStrategy.md).
+
+## Running tests
+
+Prerequisite: ensure `test/config.json` exists. Refer to its `.example` file.
+
+```bash
+# Run all test suites
+rake test:cxx GROUPS=SomethingTest
+
+# Run specific test suites
+rake test:cxx GROUPS=SomethingTest,AnotherTest
+
+# Run specific tests by number
+rake test:cxx GROUPS=SomethingTest:1,3
+
+# Attach to GDB or LLDB
+rake test:cxx GROUPS=SomethingTest GDB=1
+rake test:cxx GROUPS=SomethingTest LLDB=1
+```

packaging/binaries

@@ -32,7 +32,6 @@
 #include <oxt/thread.hpp>
 #include <string>
 #include <cstring>
-#include <exception>
 #include <sys/types.h>
 
 #include <jsoncpp/json.h>

packaging/homebrew

@@ -42,7 +42,6 @@
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <cstdlib>
-#include <cassert>
 #include <MemoryKit/palloc.h>
 #include <WrapperRegistry/Registry.h>
 #include <Hooks.h>

src/agent/Core/ApiServer.h

@@ -27,7 +27,6 @@
 #define _PASSENGER_REQUEST_HANDLER_CLIENT_H_
 
 #include <ev++.h>
-#include <ostream>
 #include <ServerKit/HttpClient.h>
 #include <Core/Controller/Request.h>
 

src/agent/Core/ApplicationPool/Group.h

@@ -27,7 +27,6 @@
 #define _PASSENGER_SECURITY_UPDATE_CHECKER_H_
 
 #include <string>
-#include <cassert>
 #include <boost/config.hpp>
 #include <boost/scoped_ptr.hpp>
 #include <oxt/thread.hpp>