Add info about remote mode in README.md

v.shepard · v.shepard · commit 9d8e662ab26c · 2023-08-02T00:55:52.000+02:00
diff --git a/README.md b/README.md
@@ -173,6 +173,33 @@ with testgres.get_new_node().init() as master:
 Note that `default_conf()` is called by `init()` function; both of them overwrite
 the configuration file, which means that they should be called before `append_conf()`.
 
+### Remote mode
+Testgres supports the creation of PostgreSQL nodes on a remote host. This is useful when you want to run distributed tests involving multiple nodes spread across different machines.
+
+To use this feature, you need to use the RemoteOperations class.
+Here is an example of how you might set this up:
+
+```python
+from testgres import ConnectionParams, RemoteOperations, TestgresConfig, get_remote_node
+
+# Set up connection params
+conn_params = ConnectionParams(
+    host='your_host',  # replace with your host
+    username='user_name',  # replace with your username
+    ssh_key='path_to_ssh_key'  # replace with your SSH key path
+)
+os_ops = RemoteOperations(conn_params)
+
+# Add remote testgres config before test
+TestgresConfig.set_os_ops(os_ops=os_ops)
+
+# Proceed with your test
+def test_basic_query(self):
+    with get_remote_node(conn_params=conn_params) as node:
+        node.init().start()
+        res = node.execute('SELECT 1')
+        self.assertEqual(res, [(1,)])
+```
 
 ## Authors
 
diff --git a/testgres/__init__.py b/testgres/__init__.py
@@ -1,4 +1,4 @@
-from .api import get_new_node
+from .api import get_new_node, get_remote_node
 from .backup import NodeBackup
 
 from .config import \
@@ -52,6 +52,7 @@
 
 __all__ = [
     "get_new_node",
+    "get_remote_node",
     "NodeBackup",
     "TestgresConfig", "configure_testgres", "scoped_config", "push_config", "pop_config",
     "NodeConnection", "DatabaseError", "InternalError", "ProgrammingError", "OperationalError",
diff --git a/testgres/api.py b/testgres/api.py
@@ -37,10 +37,18 @@ def get_new_node(name=None, base_dir=None, **kwargs):
     """
     Simply a wrapper around :class:`.PostgresNode` constructor.
     See :meth:`.PostgresNode.__init__` for details.
+    """
+    # NOTE: leave explicit 'name' and 'base_dir' for compatibility
+    return PostgresNode(name=name, base_dir=base_dir, **kwargs)
+
+
+def get_remote_node(name=None, conn_params=None):
+    """
+    Simply a wrapper around :class:`.PostgresNode` constructor for remote node.
+    See :meth:`.PostgresNode.__init__` for details.
     For remote connection you can add the next parameter:
     conn_params = ConnectionParams(host='127.0.0.1',
                                    ssh_key=None,
                                    username=default_username())
     """
-    # NOTE: leave explicit 'name' and 'base_dir' for compatibility
-    return PostgresNode(name=name, base_dir=base_dir, **kwargs)
+    return get_new_node(name=name, conn_params=conn_params)
diff --git a/tests/README.md b/tests/README.md
@@ -27,3 +27,29 @@ export PYTHON_VERSION=3  # or 2
 # Run tests
 ./run_tests.sh
 ```
+
+
+#### Remote host tests
+
+1. Start remote host or docker container
+2. Make sure that you run ssh
+```commandline
+sudo apt-get install openssh-server
+sudo systemctl start sshd
+```
+3. You need to connect to the remote host at least once to add it to the known hosts file
+4. Generate ssh keys
+5. Set up params for tests
+
+```commandline
+conn_params = ConnectionParams(
+    host='remote_host',
+    username='username',
+    ssh_key=/path/to/your/ssh/key'
+)
+os_ops = RemoteOperations(conn_params)
+```
+
+`test_remote` - Tests for RemoteOperations class.
+
+`test_simple_remote` - Tests that create node and check it. The same as `test_simple`, but for remote node. 
diff --git a/tests/test_simple_remote.py b/tests/test_simple_remote.py
