Fix merge conficts

Author: Fenimorkin

.dockerignore

@@ -0,0 +1,4 @@
+dist
+env
+venv
+*.egg-info

.gitignore

@@ -1,11 +1,13 @@
 *.pyc
 *.egg
 *.egg-info/
-dist
+.eggs/
+dist/
+build/
+docs/build/
 
 env/
 venv/
-build/
 
 .coverage
 coverage.xml

Dockerfile.tmpl

@@ -2,10 +2,12 @@ FROM postgres:${PG_VERSION}-alpine
 
 ENV PYTHON=python${PYTHON_VERSION}
 RUN if [ "${PYTHON_VERSION}" = "2" ] ; then \
-	apk add --no-cache curl python2 py-virtualenv py-pip; \
+	apk add --no-cache curl python2 python2-dev build-base musl-dev \
+    linux-headers py-virtualenv py-pip; \
 	fi
 RUN if [ "${PYTHON_VERSION}" = "3" ] ; then \
-	apk add --no-cache curl python3 py-virtualenv; \
+	apk add --no-cache curl python3 python3-dev build-base musl-dev \
+    linux-headers py-virtualenv; \
 	fi
 ENV LANG=C.UTF-8
 

LICENSE

@@ -1,6 +1,6 @@
 testgres is released under the PostgreSQL License, a liberal Open Source license, similar to the BSD or MIT licenses.
 
-Copyright (c) 2016-2017, Postgres Professional
+Copyright (c) 2016-2018, Postgres Professional
 
 Permission to use, copy, modify, and distribute this software and its documentation for any purpose, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and this paragraph and the following two paragraphs appear in all copies.
 

MANIFEST

@@ -0,0 +1,8 @@
+include LICENSE
+include README.md
+include setup.cfg
+
+recursive-include testgres *.py
+recursive-include tests *.py
+
+global-exclude *.pyc

MANIFEST.in

@@ -37,80 +37,34 @@ python my_tests.py
 ```
 
 
-### Logging
-
-By default, `cleanup()` removes all temporary files (DB files, logs etc) that were created by testgres' API methods.
-If you'd like to keep logs, execute `configure_testgres(node_cleanup_full=False)` before running any tests.
-
-> Note: context managers (aka `with`) call `stop()` and `cleanup()` automatically.
-
-testgres supports [python logging](https://docs.python.org/3.6/library/logging.html),
-which means that you can aggregate logs from several nodes into one file:
-
-```python
-import logging
-
-# write everything to /tmp/testgres.log
-logging.basicConfig(filename='/tmp/testgres.log')
-
-# create two different nodes with logging
-node1 = testgres.get_new_node(use_logging=True).init().start()
-node2 = testgres.get_new_node(use_logging=True).init().start()
-
-# execute a few queries
-node1.execute('postgres', 'select 1')
-node2.execute('postgres', 'select 2')
-```
-
-
 ### Examples
 
 Here is an example of what you can do with `testgres`:
 
 ```python
-with testgres.get_new_node('test') as node:
-    node.init()  # run initdb
-    node.start() # start PostgreSQL
-    print(node.execute('postgres', 'select 1'))
-    node.stop()  # stop PostgreSQL
-```
-
-Let's walk through the code. First, you create a new node using:
-
-```python
-with testgres.get_new_node('master') as node:
-```
-
-or
-
-```python
-with testgres.get_new_node('master', '/path/to/DB') as node:
-```
+# create a node with random name, port, etc
+with testgres.get_new_node() as node:
 
-where `master` is a node's application name. Name matters if you're testing something like replication.
-Function `get_new_node()` only creates directory structure in specified directory (or somewhere in '/tmp' if
-we did not specify base directory) for cluster. After that, we have to initialize the PostgreSQL cluster:
+    # run inidb
+    node.init()
 
-```python
-node.init()
-```
+    # start PostgreSQL
+    node.start()
 
-This function runs `initdb` command and adds some basic configuration to `postgresql.conf` and `pg_hba.conf` files.
-Function `init()` accepts optional parameter `allows_streaming` which configures cluster for streaming replication (default is `False`).
-Now we are ready to start:
+    # execute a query in a default DB
+    print(node.execute('select 1'))
 
-```python
-node.start()
+# ... node stops and its files are about to be removed
 ```
 
-Finally, our temporary cluster is able to process queries. There are four ways to run them:
+There are four API methods for runnig queries:
 
 | Command | Description |
 |----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
-| `node.psql(dbname, query)` | Runs query via `psql` command and returns tuple `(error code, stdout, stderr)`. |
-| `node.safe_psql(dbname, query)` | Same as `psql()` except that it returns only `stdout`. If an error occures during the execution, an exception will be thrown. |
-| `node.execute(dbname, query)` | Connects to PostgreSQL using `psycopg2` or `pg8000` (depends on which one is installed in your system) and returns two-dimensional array with data. |
-| `node.connect(dbname, username)` | Returns connection wrapper (`NodeConnection`) capable of running several queries within a single transaction. |
+| `node.psql(query, ...)` | Runs query via `psql` command and returns tuple `(error code, stdout, stderr)`. |
+| `node.safe_psql(query, ...)` | Same as `psql()` except that it returns only `stdout`. If an error occures during the execution, an exception will be thrown. |
+| `node.execute(query, ...)` | Connects to PostgreSQL using `psycopg2` or `pg8000` (depends on which one is installed in your system) and returns two-dimensional array with data. |
+| `node.connect(dbname, ...)` | Returns connection wrapper (`NodeConnection`) capable of running several queries within a single transaction. |
 
 The last one is the most powerful: you can use `begin(isolation_level)`, `commit()` and `rollback()`:
 ```python
@@ -120,12 +74,39 @@ with node.connect() as con:
     con.rollback()
 ```
 
-To stop the server, run:
+
+### Logging
+
+By default, `cleanup()` removes all temporary files (DB files, logs etc) that were created by testgres' API methods.
+If you'd like to keep logs, execute `configure_testgres(node_cleanup_full=False)` before running any tests.
+
+> Note: context managers (aka `with`) call `stop()` and `cleanup()` automatically.
+
+`testgres` supports [python logging](https://docs.python.org/3.6/library/logging.html),
+which means that you can aggregate logs from several nodes into one file:
 
 ```python
-node.stop()
+import logging
+
+# write everything to /tmp/testgres.log
+logging.basicConfig(filename='/tmp/testgres.log')
+
+# enable logging, and create two different nodes
+testgres.configure_testgres(enable_python_logging=True)
+node1 = testgres.get_new_node().init().start()
+node2 = testgres.get_new_node().init().start()
+
+# execute a few queries
+node1.execute('select 1')
+node2.execute('select 2')
+
+# disable logging
+testgres.configure_testgres(enable_python_logging=False)
 ```
 
+Look at `tests/test_simple.py` file for a complete example of the logging
+configuration.
+
 
 ### Backup & replication
 
@@ -134,7 +115,10 @@ It's quite easy to create a backup and start a new replica:
 ```python
 with testgres.get_new_node('master') as master:
     master.init().start()
+
+    # create a backup
     with master.backup() as backup:
+
         # create and start a new replica
         replica = backup.spawn_replica('replica').start()
 
@@ -147,7 +131,7 @@ with testgres.get_new_node('master') as master:
 
 ### Benchmarks
 
-`testgres` also can help you to make benchmarks using `pgbench` from postgres installation:
+`testgres` is also capable of running benchmarks using `pgbench`:
 
 ```python
 with testgres.get_new_node('master') as master:
@@ -160,9 +144,37 @@ with testgres.get_new_node('master') as master:
 ```
 
 
+### Custom configuration
+
+It's often useful to extend default configuration provided by `testgres`.
+
+`testgres` has `default_conf()` function that helps control some basic
+options. The `append_conf()` function can be used to add custom
+lines to configuration lines:
+
+```python
+ext_conf = "shared_preload_libraries = 'postgres_fdw'"
+
+# initialize a new node
+with testgres.get_new_node().init() as master:
+
+    # ... do something ...
+	
+    # reset main config file
+    master.default_conf(fsync=True,
+                        allow_streaming=True)
+
+    # add a new config line
+    master.append_conf('postgresql.conf', ext_conf)
+```
+
+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()`.
+
+
 ## Authors
 
-[Ildar Musin](https://github.com/zilder) <i.musin(at)postgrespro.ru> Postgres Professional Ltd., Russia     
-[Dmitry Ivanov](https://github.com/funbringer) <d.ivanov(at)postgrespro.ru> Postgres Professional Ltd., Russia   
-[Ildus Kurbangaliev](https://github.com/ildus) <i.kurbangaliev(at)postgrespro.ru> Postgres Professional Ltd., Russia     
-[Yury Zhuravlev](https://github.com/stalkerg) <stalkerg(at)gmail.com>
+[Ildar Musin](https://github.com/zilder) <i.musin(at)postgrespro.ru> Postgres Professional Ltd., Russia  
+[Dmitry Ivanov](https://github.com/funbringer) <d.ivanov(at)postgrespro.ru> Postgres Professional Ltd., Russia  
+[Ildus Kurbangaliev](https://github.com/ildus) <i.kurbangaliev(at)postgrespro.ru> Postgres Professional Ltd., Russia  
+[Yury Zhuravlev](https://github.com/stalkerg) <stalkerg(at)gmail.com>  

README.md

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = testgres
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/Makefile

@@ -0,0 +1,15 @@
+# Building the documentation
+
+Make sure you have `Sphinx` and `sphinxcontrib-napoleon` packages installed:
+
+```
+pip install Sphinx sphinxcontrib-napoleon
+```
+
+Then just run
+
+```
+make html
+```
+
+Documentation will be built in `build/html` directory. Other output formats are also available; run `make` without arguments to see the options.