├── .gitignore ├── .projectile ├── README.md ├── docker ├── Dockerfile ├── build.sh ├── fs-build-1 │ └── usr │ │ └── local │ │ └── bin │ │ └── fetch-executable ├── fs-server-1 │ └── etc │ │ └── apt │ │ └── apt.conf.d │ │ └── noninteractive-upgrade └── fs-server-2 │ └── etc │ └── runit │ └── runsvdir │ └── default │ ├── postgresql │ └── run │ └── tempgres │ ├── _roles.sh │ ├── _wait-online.sh │ └── run └── server ├── .dockerignore ├── LICENSE.txt ├── Setup.hs ├── build-static.sh ├── package.yaml ├── src ├── Main.hs └── Tempgres │ ├── Configuration.hs │ ├── DatabaseId.hs │ └── Mutex.hs ├── stack.yaml └── stack.yaml.lock /.gitignore: -------------------------------------------------------------------------------- 1 | /.hsenv_* 2 | /.hsenv 3 | .idea 4 | *.iml 5 | /out 6 | .cabal-sandbox 7 | .stack-work/ 8 | dist-newstyle/ 9 | dist/ 10 | dist_*/ 11 | cabal.sandbox.config 12 | /.ghc.environment.* 13 | *.cabal 14 | -------------------------------------------------------------------------------- /.projectile: -------------------------------------------------------------------------------- 1 | -/dist 2 | -/dist-newstyle 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Tempgres 2 | 3 | `tempgres` is a REST service for conveniently creating temporary 4 | PostgreSQL databases. It is intended for use from tests. 5 | 6 | ## Why? 7 | 8 | This is mostly aimed at integration-type tests you usually want to use a) a real 9 | database, and b) want to start with a fresh database for every test case. Using 10 | this REST service eliminates the setup (users, configuration, database server, 11 | etc.) which would be necessary for using temporary databases for tests locally 12 | on a development machine -- all you need is a single URL. 13 | 14 | If you have a group of developers, you'll probably want to run a single tempgres 15 | instance in your development LAN so that everybody can share it and can use the 16 | same URL. The URL could also be baked into the default test configuration so 17 | that developers don't have to do any setup to get tests up and running. 18 | 19 | ## Usage 20 | 21 | Once the service is set up and running (see below), you can do a HTTP 22 | POST to it to create a temporary database. For example, 23 | 24 | ``` 25 | $ curl -d '' http://localhost:15431 26 | tempgres-client 27 | tempgres-cpass 28 | localhost 29 | 15432 30 | temp_jm1sufkdkdyn1ekifld1nyblj8vuomjz9 31 | ``` 32 | 33 | The response indicates that the temporary database 34 | `temp_jm1sufkd...` has been created on the 35 | database server `localhost` (port 15432) and made available to the user 36 | `tempgres-client` using the password `tempgres-cpass`. 37 | 38 | The database will automatically be destroyed after a configurable 39 | duration, though any temporary databases that have not been destroyed 40 | when the service is stopped will stay around. All temporary databases 41 | will be named `temp_...`. 42 | 43 | ## Clients 44 | 45 | - [Haskell](http://hackage.haskell.org/package/tempgres-client) 46 | - [Java](https://github.com/ClockworkConsulting/tempgres-client) 47 | 48 | ## Security Notice 49 | 50 | This service is strictly meant for use on one's own computer or on development 51 | LANs which are firewalled off from the public Internet. 52 | 53 | ## Installation 54 | 55 | The recommended way to install on your own system is to 56 | use the [container from DockerHub](https://hub.docker.com/repository/docker/cwconsult/tempgres): 57 | 58 | ```sh 59 | $ docker run -p 15431:8080 -p 15432:5432 -d cwconsult/tempgres:latest 60 | ``` 61 | 62 | To adjust the ports (15431, 15432) you will need to set the `HTTP_PORT` and 63 | `TEMPGRES_PUBLISHED_ADDRESS_PORT` environment variables when starting the 64 | container. You can also set other environment variables to control 65 | the user name, passwords, etc. See the `Dockerfile` and `Configuration.hs` 66 | for details. 67 | 68 | You might also want to specify a fixed tag above, e.g. `cwconsult/tempgres:v3.0.0` 69 | 70 | ## Building 71 | 72 | If you need customization beyond what environment variables allow, 73 | you may produce your own container image by running 74 | 75 | ```sh 76 | $ ./docker/build.sh 77 | ``` 78 | 79 | This builds everything, and should produce some output akin to: 80 | 81 | ``` text 82 | ... 83 | => exporting to image 84 | => => exporting layers 85 | => => writing image sha256:f47ee2bb5dd2d1df6577439a421fe00383eb599193d395a96178fb2d2360cfba 86 | => => naming to docker.io/library/tempgres:latest 87 | ``` 88 | 89 | To run the container, follow the instruction above, but 90 | specify `sha256:f47ee2bb5dd2d1df657743...` as the name 91 | of the container instead of `cwconsult/tempgres`. 92 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | #syntax=docker/dockerfile:1.4 2 | 3 | #---------------------------------------------------------------- 4 | # Build Stage 1: Base 'generic' ghc + stack image 5 | #---------------------------------------------------------------- 6 | 7 | FROM alpine:3.15.3 AS bld-stage1 8 | 9 | # Note that the version here *MUST* match the GHC version of the 10 | # Stackage LTS that we're using. The build will fail, badly, if 11 | # that is not the case. 12 | ARG GHC_VERSION="9.0.2" 13 | # It is tempting to change this to use *_VERSION variables and interpolate those 14 | # into the *_URL variables, but using URLs is much robust to upstream changes. 15 | ARG GHCUP_URL="https://downloads.haskell.org/ghcup/0.1.17.6/x86_64-linux-ghcup-0.1.17.6" 16 | ARG STACK_URL=https://github.com/commercialhaskell/stack/releases/download/v2.7.5/stack-2.7.5-linux-x86_64-bin 17 | 18 | # Copy config and tools 19 | COPY --chown=0:0 docker/fs-build-1/ / 20 | 21 | # Base development tools for stack/ghc to use. 22 | RUN apk update \ 23 | && apk add \ 24 | gcc g++ bash git make xz tar binutils-gold \ 25 | perl curl file automake autoconf dpkg \ 26 | fakeroot findutils shadow 27 | 28 | # Install development libraries which are very typically required for Haskell 29 | # projects. 30 | RUN apk add \ 31 | gmp-dev ncurses-dev \ 32 | libffi libffi-dev \ 33 | openssl-dev openssl-libs-static \ 34 | xz xz-dev ncurses-static \ 35 | pcre pcre-dev pcre2 pcre2-dev \ 36 | bzip2 bzip2-dev bzip2-static \ 37 | curl libcurl curl-static \ 38 | zlib zlib-dev zlib-static 39 | 40 | # Install ghcup 41 | ENV GHCUP_INSTALL_BASE_PREFIX=/usr/local 42 | ARG GHCUP_BIN_DIR=${GHCUP_INSTALL_BASE_PREFIX}/.ghcup/bin 43 | RUN fetch-executable "$GHCUP_URL" "${GHCUP_BIN_DIR}/ghcup" 44 | 45 | # Set up paths 46 | ENV PATH="${GHCUP_BIN_DIR}:$PATH" 47 | 48 | # Install the compiler which stack will use 49 | RUN ghcup install ghc "$GHC_VERSION" \ 50 | && ghcup set ghc "$GHC_VERSION" 51 | 52 | # Install stack 53 | ARG STACK=/usr/local/bin/stack 54 | RUN fetch-executable "${STACK_URL}" "${STACK}" 55 | 56 | #---------------------------------------------------------------- 57 | # Build Stage 2: Install project-specific C libraries 58 | #---------------------------------------------------------------- 59 | 60 | FROM bld-stage1 AS bld-stage2 61 | 62 | # Project C library dependencies 63 | RUN apk add \ 64 | # 'libpq' library 65 | postgresql-dev \ 66 | # 'ldap' library 67 | openldap-dev \ 68 | # 'hcrypto', etc. 69 | heimdal-dev \ 70 | # 'gdbm' library 71 | gdbm-dev \ 72 | # 'sqlite3' library 73 | sqlite-static \ 74 | # 'sasl2' library 75 | cyrus-sasl-static \ 76 | # 'gss' library 77 | libgss-dev \ 78 | # 'com_err' library 79 | e2fsprogs-static 80 | 81 | #---------------------------------------------------------------- 82 | # Build Stage 3: Build the project. 83 | #---------------------------------------------------------------- 84 | 85 | FROM bld-stage2 AS bld-stage3 86 | 87 | ARG STACK_ROOT=/cache/stack-root 88 | ARG STACK_WORK=.stack-work-docker 89 | RUN --mount=type=bind,source=server,target=/src,rw \ 90 | --mount=type=cache,target=/cache \ 91 | --mount=type=cache,target=/src/.stack-work-docker \ 92 | cd src && ./build-static.sh 93 | 94 | #---------------------------------------------------------------- 95 | # Server Stage 1: Base container for the server. 96 | #---------------------------------------------------------------- 97 | 98 | # We use a different base image because we actually 99 | # need a proper database inside the container for it 100 | # to form a coherent 'logical' service. 101 | FROM phusion/baseimage:focal-1.2.0 as srv-stage1 102 | 103 | # Copy the file system contents 104 | COPY --chown=0:0 docker/fs-server-1/ / 105 | 106 | # Ask for non-interactive package installation 107 | ARG DEBIAN_FRONTEND=noninteractive 108 | 109 | # Update with security updates; it is important 110 | # that we always do this -- otherwise package 111 | # installation may fail. 112 | RUN apt-get update && apt-get dist-upgrade 113 | 114 | # Install everything we need into the base image 115 | RUN apt-get install postgresql-12 116 | 117 | # Remove APT files; we should not be installing anything 118 | # in later stages. 119 | RUN apt-get clean -y && \ 120 | rm -rf \ 121 | /var/lib/apt/lists/* \ 122 | /tmp/* \ 123 | /var/tmp/* \ 124 | /var/log/dpkg.log \ 125 | /var/log/alternatives.log \ 126 | /var/log/apt 127 | 128 | #---------------------------------------------------------------- 129 | # Server Stage 2: Set up the server 130 | #---------------------------------------------------------------- 131 | 132 | FROM srv-stage1 133 | 134 | # Copy the binary in 135 | COPY --from=bld-stage3 /artifacts/tempgres-server /usr/local/bin 136 | 137 | # Configuration 138 | ENV HTTP_PORT 15431 139 | ENV TEMPGRES_PUBLISHED_ADDRESS_PORT 15432 140 | ENV TEMPGRES_PUBLISHED_ADDRESS_HOST localhost 141 | ENV TEMPGRES_ADMIN_USER tempgres-admin 142 | ENV TEMPGRES_ADMIN_PASS tempgres-apass 143 | ENV TEMPGRES_CLIENT_USER tempgres-client 144 | ENV TEMPGRES_CLIENT_PASS tempgres-cpass 145 | 146 | # Exposed ports; we'll need to expose the embedded PostgreSQL instance too. 147 | EXPOSE ${HTTP_PORT} ${TEMPGRES_PUBLISHED_ADDRESS_PORT} 148 | 149 | # Copy all the file system bits; these contain the service files 150 | # which initialize the database, set up roles, etc. 151 | COPY --chown=0:0 docker/fs-server-2/ / 152 | 153 | # Create tempgres user 154 | RUN useradd --system tempgres 155 | 156 | # Fix up permissions 157 | RUN chmod a+rX /etc 158 | RUN chmod -R a+rX /etc/runit/runsvdir/default/tempgres 159 | -------------------------------------------------------------------------------- /docker/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | 4 | ROOT_DIR="$(git rev-parse --show-toplevel)" 5 | CONTEXT_DIR="${ROOT_DIR}" 6 | 7 | DOCKER_BUILDKIT=1 docker build -f "${CONTEXT_DIR}/docker/Dockerfile" -t tempgres:latest "${CONTEXT_DIR}" 8 | -------------------------------------------------------------------------------- /docker/fs-build-1/usr/local/bin/fetch-executable: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | 4 | URL=$1 5 | DEST=$2 6 | 7 | curl -L --fail --create-dirs -o "${DEST}" "${URL}" 8 | chmod +x "${DEST}" 9 | -------------------------------------------------------------------------------- /docker/fs-server-1/etc/apt/apt.conf.d/noninteractive-upgrade: -------------------------------------------------------------------------------- 1 | // Set up the options to avoid any prompts during upgrade 2 | Dpkg::Options:: "--force-confdef"; 3 | Dpkg::Options:: "--force-confold"; 4 | APT::Get { 5 | Assume-Yes "true"; 6 | } 7 | -------------------------------------------------------------------------------- /docker/fs-server-2/etc/runit/runsvdir/default/postgresql/run: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -eu 4 | 5 | # 6 | # Cluster configuration 7 | # 8 | CLUSTER_NAME=main 9 | CLUSTER_VERSION=12 10 | 11 | # Initialize a fresh PostgreSQL cluster, just in case there were 12 | # databases left behind from last run. This also ensures clean 13 | # configuration files for manipulation below. 14 | /usr/bin/pg_dropcluster --stop ${CLUSTER_VERSION} ${CLUSTER_NAME} || exit 0 15 | /usr/bin/pg_createcluster ${CLUSTER_VERSION} ${CLUSTER_NAME} 16 | 17 | # Make sure PostgreSQL will accept connections from anywhere, and use 18 | # options to ensure minimum durability and maximum speed. 19 | cat << EOF >> /etc/postgresql/${CLUSTER_VERSION}/${CLUSTER_NAME}/pg_hba.conf 20 | host all all 0.0.0.0/0 md5 21 | EOF 22 | 23 | cat << EOF >> /etc/postgresql/${CLUSTER_VERSION}/${CLUSTER_NAME}/postgresql.conf 24 | listen_addresses='*' 25 | max_connections=768 26 | fsync=off 27 | synchronous_commit=off 28 | EOF 29 | 30 | # Start PostgreSQL in the foreground. 31 | pg_ctlcluster --foreground ${CLUSTER_VERSION} ${CLUSTER_NAME} start 32 | -------------------------------------------------------------------------------- /docker/fs-server-2/etc/runit/runsvdir/default/tempgres/_roles.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo "Creating roles..." 4 | psql -o /dev/null < /dev/null 2>&1 ; do 3 | echo "Waiting for PostgreSQL to start..." 4 | sleep 1 5 | done 6 | -------------------------------------------------------------------------------- /docker/fs-server-2/etc/runit/runsvdir/default/tempgres/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | set -eu 3 | 4 | # Wait for PostgreSQL to come online 5 | su postgres ./_wait-online.sh 6 | 7 | # Create the necessary roles 8 | su postgres ./_roles.sh 9 | 10 | # Start the server. This process does not daemonize. 11 | exec su tempgres -c /usr/local/bin/tempgres-server 12 | -------------------------------------------------------------------------------- /server/.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | **/.stack-work 3 | **/Dockerfile 4 | **/.dockerignore 5 | -------------------------------------------------------------------------------- /server/LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /server/Setup.hs: -------------------------------------------------------------------------------- 1 | import Distribution.Simple 2 | main = defaultMain 3 | -------------------------------------------------------------------------------- /server/build-static.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | 4 | # Libraries we must link in to have a fully static 5 | # binary. 6 | LIBS=( 7 | # Order is extremely important here; symbols 8 | # required by a library must be provided by 9 | # a library LATER in the list. 10 | pq 11 | pgcommon 12 | pgport 13 | ldap 14 | ssl 15 | crypto 16 | lber 17 | sasl2 18 | gssapi 19 | gss 20 | krb5 21 | hx509 22 | asn1 23 | hcrypto 24 | roken 25 | wind 26 | heimbase 27 | sqlite3 28 | com_err 29 | heimntlm 30 | crypto 31 | gdbm 32 | ) 33 | 34 | # Build the command line linker options 35 | OPTL_OPTS=() 36 | for LIB in "${LIBS[@]}"; do 37 | OPTL_OPTS+=("-optl-l$LIB") 38 | done 39 | 40 | # Function to add the options we always 41 | # need. 42 | stack() { 43 | /usr/local/bin/stack --system-ghc --allow-different-user "$@" 44 | } 45 | 46 | # Build 47 | stack test \ 48 | --ghc-options \ 49 | "${OPTL_OPTS[*]} -static \ 50 | -optl-static \ 51 | -optl-pthread \ 52 | -fPIC" \ 53 | tempgres-server 54 | 55 | # Copy the build artifact to a well-known location. 56 | mkdir /artifacts 57 | cp `stack path --local-install-root`/bin/tempgres-server /artifacts 58 | -------------------------------------------------------------------------------- /server/package.yaml: -------------------------------------------------------------------------------- 1 | name: tempgres-server 2 | version: "2.1.0" 3 | synopsis: REST service for creating temporary PostgreSQL databases. 4 | description: > 5 | REST service for conveniently creating temporary PostgreSQL databases 6 | for use in tests. 7 | . 8 | See for 9 | detailed usage and setup instructions. 10 | license: AGPL-3 11 | license-file: LICENSE.txt 12 | author: Bardur Arantsson 13 | maintainer: bardur@scientician.net 14 | copyright: Copyright (c) 2014-2021 Bardur Arantsson 15 | category: Database Testing Web 16 | data-dir: data 17 | github: ClockworkConsulting/tempgres-server 18 | 19 | ghc-options: 20 | - -Wall 21 | - -Wmissing-fields 22 | - -threaded 23 | 24 | default-extensions: 25 | - DeriveGeneric 26 | - DerivingVia 27 | - ImportQualifiedPost 28 | - LambdaCase 29 | - OverloadedStrings 30 | 31 | dependencies: 32 | - base 33 | - async 34 | - envy 35 | - postgresql-simple 36 | - random 37 | - scotty 38 | - text 39 | - transformers 40 | - warp 41 | 42 | executables: 43 | tempgres-server: 44 | source-dirs: src 45 | main: Main.hs 46 | other-modules: 47 | - Tempgres.Configuration 48 | - Tempgres.Mutex 49 | - Tempgres.DatabaseId 50 | -------------------------------------------------------------------------------- /server/src/Main.hs: -------------------------------------------------------------------------------- 1 | {- 2 | tempgres, REST service for creating temporary PostgreSQL databases. 3 | Copyright (C) 2014-2020 Bardur Arantsson 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU Affero General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU Affero General Public License for more details. 14 | 15 | You should have received a copy of the GNU Affero General Public License 16 | along with this program. If not, see . 17 | -} 18 | {-# LANGUAGE RecordWildCards #-} 19 | {-# LANGUAGE ScopedTypeVariables #-} 20 | module Main ( main ) where 21 | 22 | import Control.Concurrent (threadDelay) 23 | import Control.Concurrent.Async (async, withAsync, waitCatch) 24 | import Control.Exception (bracket) 25 | import Control.Monad (void, replicateM) 26 | import Control.Monad.IO.Class (MonadIO, liftIO) 27 | import Data.String (fromString) 28 | import Data.Text.Lazy qualified as TL 29 | import Database.PostgreSQL.Simple (Connection, ConnectInfo(..), Only(..)) 30 | import Database.PostgreSQL.Simple qualified as P 31 | import Network.Wai.Handler.Warp (setPort, setHost, defaultSettings) 32 | import System.IO (stderr, hPutStrLn) 33 | import System.Random (randomRIO) 34 | import Tempgres.Configuration 35 | import Tempgres.DatabaseId 36 | import Tempgres.Mutex 37 | import Web.Scotty (ScottyM, Options(..), scottyOpts, post, text) 38 | 39 | -- Perform an operation with an open connection to the database. 40 | -- The connection will automatically be closed after the operation 41 | -- completes, regardless of whether it completes successfully or 42 | -- not (e.g. if there's an exception). 43 | withConnection :: Configuration -> (Connection -> IO a) -> IO a 44 | withConnection Configuration{..} action = bracket (P.connect connectInfo) P.close action 45 | where 46 | connectInfo = ConnectInfo 47 | { connectHost = cfgDatabaseHost 48 | , connectPort = cfgDatabasePort 49 | , connectUser = cfgAdminUser 50 | , connectPassword = cfgAdminPass 51 | , connectDatabase = unquotedIdentifier cfgDatabase 52 | } 53 | 54 | -- Create a random valid PostgreSQL identifier. 55 | mkRandomIdent :: IO String 56 | mkRandomIdent = do 57 | h <- chooseElement letters 58 | t <- replicateM 32 $ chooseElement lettersAndDigits 59 | return (h:t) 60 | where 61 | letters = "abcdefhijklmnopqrstuvwxyz" 62 | digits = "0123456789" 63 | lettersAndDigits = letters ++ digits 64 | chooseElement t = do 65 | i <- randomRIO (0, length t - 1) 66 | return $ t !! i 67 | 68 | -- Create temporary database ID. 69 | mkTemporaryDatabaseId :: IO (Either String DatabaseId) 70 | mkTemporaryDatabaseId = fmap mkDatabaseId $ fmap ("temp_" ++) mkRandomIdent 71 | 72 | -- Create temporary database and return its name. 73 | createTemporaryDatabase :: Configuration -> DatabaseId -> IO () 74 | createTemporaryDatabase configuration@Configuration{..} databaseId = do 75 | -- Connect to the administrative database. 76 | withConnection configuration $ \connection -> do 77 | -- Create the temporary database. 78 | void $ P.execute_ connection $ createSql 79 | putStrLn $ "Created temporary database: " ++ sqlDatabaseId 80 | -- Spawn a thread to kill the database after a certain delay. 81 | void $ async $ do 82 | threadDelay $ cfgDurationSeconds * 1000000 83 | dropDatabase configuration databaseId 84 | where 85 | createSql = fromString $ 86 | "CREATE DATABASE " ++ sqlDatabaseId ++ 87 | " WITH TEMPLATE " ++ sqlIdentifier cfgTemplateDatabase ++ 88 | " OWNER \"" ++ cfgClientUser ++ "\"" 89 | 90 | sqlDatabaseId = sqlIdentifier databaseId 91 | 92 | dropDatabase :: Configuration -> DatabaseId -> IO () 93 | dropDatabase configuration databaseId = 94 | -- Since this is running in a separate thread we need explicit 95 | -- exception handling to avoid silent exceptions. 96 | withAsync doDropDatabase waitCatch >>= \case 97 | Left exc -> hPutStrLn stderr $ "Exception occurred while creating temporary database: " ++ show exc 98 | Right _ -> return () 99 | where 100 | doDropDatabase = withConnection configuration $ \connection -> do 101 | -- We need to block new connections to the temporary database; otherwise 102 | -- a reconnect during the destruction could foil our attempt to drop. 103 | void $ P.execute_ connection blockConnectionsSql 104 | -- Now we can kill the backends, i.e. terminate all the connections. No 105 | -- new connections can be created because of the previous block. 106 | P.forEach_ connection terminateConnectionsSql $ \(Only (_::Bool)) -> return () 107 | -- Finally, we can drop. 108 | void $ P.execute_ connection dropSql 109 | -- Logging 110 | putStrLn $ "Dropped temporary database: " ++ sqlDatabaseId 111 | 112 | dropSql = fromString $ 113 | "DROP DATABASE " ++ sqlDatabaseId 114 | 115 | blockConnectionsSql = fromString $ 116 | "UPDATE pg_database \ 117 | \ SET datallowconn = FALSE \ 118 | \ WHERE datname = '" ++ sqlDatabaseId ++ "'" 119 | 120 | terminateConnectionsSql = fromString $ 121 | "SELECT pg_terminate_backend(pid) \ 122 | \ FROM pg_stat_activity \ 123 | \ WHERE pid <> pg_backend_pid() \ 124 | \ AND datname = '" ++ sqlDatabaseId ++ "'" 125 | 126 | sqlDatabaseId = sqlIdentifier databaseId 127 | 128 | -- Handle a create request, returns the database ID. 129 | handleCreateRequest :: MonadIO m => Configuration -> Mutex -> m DatabaseId 130 | handleCreateRequest configuration mutex = do 131 | -- Generate a name for temporary database. 132 | liftIO mkTemporaryDatabaseId >>= \case 133 | Left err -> 134 | error err -- We're generating the name ourselves, so no error 135 | -- handling needed. 136 | Right databaseId -> do 137 | -- Create the temporary database. 138 | liftIO $ withMutex mutex $ createTemporaryDatabase configuration databaseId 139 | return databaseId 140 | 141 | -- REST interface 142 | routes :: Configuration -> Mutex -> ScottyM () 143 | routes configuration@Configuration{..} mutex = do 144 | -- Add all the routes. 145 | post "/" $ do 146 | databaseId <- handleCreateRequest configuration mutex 147 | text $ TL.unlines 148 | [ TL.pack $ cfgClientUser 149 | , TL.pack $ cfgClientPass 150 | , TL.pack $ cfgPublishedAddressHost 151 | , TL.pack $ show $ cfgPublishedAddressPort 152 | , TL.pack $ unquotedIdentifier databaseId 153 | ] 154 | 155 | main :: IO () 156 | main = do 157 | -- Load configuration from environment. 158 | loadConfiguration >>= \case 159 | Left msg -> hPutStrLn stderr msg 160 | Right configuration -> do 161 | -- Build options for Warp. 162 | let warpSettings = 163 | setPort (cfgListenPort configuration) $ 164 | setHost (fromString $ cfgListenHost configuration) $ 165 | defaultSettings 166 | options = Options { verbose = 1 167 | , settings = warpSettings 168 | } 169 | -- Mutex to prevent multiple "create" requests from being 170 | -- processed simultaneously; PostgreSQL cannot handle 171 | -- "cloning" a template concurrently. 172 | mutex <- mkMutex 173 | -- Force immediate creation of a single temporary database; we 174 | -- do this so that any configuration issues will become obvious 175 | -- on startup. 176 | void $ handleCreateRequest configuration mutex 177 | -- Start the web serving thread 178 | putStrLn $ "Starting with configuration: " ++ show configuration 179 | scottyOpts options $ routes configuration mutex 180 | -------------------------------------------------------------------------------- /server/src/Tempgres/Configuration.hs: -------------------------------------------------------------------------------- 1 | {- 2 | tempgres, REST service for creating temporary PostgreSQL databases. 3 | Copyright (C) 2014-2020 Bardur Arantsson 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU Affero General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU Affero General Public License for more details. 14 | 15 | You should have received a copy of the GNU Affero General Public License 16 | along with this program. If not, see . 17 | -} 18 | module Tempgres.Configuration 19 | ( Configuration(..) 20 | , loadConfiguration 21 | ) where 22 | 23 | import Data.Word (Word16) 24 | import GHC.Generics 25 | import System.Envy 26 | import Tempgres.DatabaseId (unsafeMkDatabaseId, DatabaseId) 27 | 28 | -- | Configuration settings; read from environment variables. 29 | -- Implementation note: The spellings here may be a bit strange, 30 | -- because envy does a translation to environment variable names. 31 | data Configuration = Configuration 32 | { cfgListenPort :: Int -- Port to listen to for requests 33 | , cfgListenHost :: String -- Host/interface to listen to for requests 34 | , cfgAdminUser :: String -- Administrator user's user name 35 | , cfgAdminPass :: String -- Administrator user's password 36 | , cfgPublishedAddressHost :: String -- PostgreSQL host. The host name is returned 37 | -- without translation in the REST interface, 38 | -- so you'll want to use a FQDN. 39 | , cfgPublishedAddressPort :: Word16 -- Port that your PostgreSQL instance is listening on. 40 | , cfgDatabase :: DatabaseId -- Database the administrator user will connect 41 | -- to when creating/dropping databases. This 42 | -- database MUST exist, but will NOT be modified 43 | -- in any way. 44 | , cfgDatabasePort :: Word16 -- The local port to use to connect to the database. 45 | , cfgDatabaseHost :: String -- The local host name to use to connect to the database. 46 | , cfgClientUser :: String -- User which the REST service will return for the 47 | -- test database. The test user will be the owner 48 | -- of all temporary databases that are created. 49 | , cfgClientPass :: String -- Password for the test user. 50 | , cfgTemplateDatabase :: DatabaseId -- Database to use as a template for the temporary database. 51 | -- It is recommended that you use either a) an empty template, 52 | -- or, b) a snapshot of your production schema from the last 53 | -- production release. The latter is helpful for testing 54 | -- any schema migrations you may have pending for the next 55 | -- release. 56 | , cfgDurationSeconds :: Int -- Duration of temporary databases. All existing connections 57 | -- to the temporary database will be killed and the database will 58 | -- be dropped after this amount of time. 59 | } deriving (Generic, Show) 60 | 61 | loadConfiguration :: IO (Either String Configuration) 62 | loadConfiguration = runEnv $ gFromEnvCustom option defaults 63 | where 64 | option = defOption 65 | { dropPrefixCount = 3 66 | , customPrefix = "TEMPGRES" 67 | } 68 | 69 | defaults = Just $ Configuration 70 | { cfgListenPort = 8080 71 | , cfgListenHost = "*" 72 | , cfgAdminUser = "tempgres-admin" 73 | , cfgAdminPass = "tempgres-apass" 74 | , cfgDatabase = unsafeMkDatabaseId "postgres" 75 | , cfgDatabasePort = 5432 76 | , cfgDatabaseHost = "localhost" 77 | , cfgPublishedAddressHost = "localhost" 78 | , cfgPublishedAddressPort = 5432 79 | , cfgClientUser = "tempgres-client" 80 | , cfgClientPass = "tempgres-cpass" 81 | , cfgTemplateDatabase = unsafeMkDatabaseId "template1" 82 | , cfgDurationSeconds = 300 83 | } 84 | -------------------------------------------------------------------------------- /server/src/Tempgres/DatabaseId.hs: -------------------------------------------------------------------------------- 1 | {- 2 | tempgres, REST service for creating temporary PostgreSQL databases. 3 | Copyright (C) 2014-2020 Bardur Arantsson 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU Affero General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU Affero General Public License for more details. 14 | 15 | You should have received a copy of the GNU Affero General Public License 16 | along with this program. If not, see . 17 | -} 18 | module Tempgres.DatabaseId 19 | ( DatabaseId 20 | , mkDatabaseId 21 | , sqlIdentifier 22 | , unquotedIdentifier 23 | , unsafeMkDatabaseId 24 | ) where 25 | 26 | import Data.Either (fromRight) 27 | import System.Envy (Var(..)) 28 | 29 | -- Newtype to prevent unsafe construction. 30 | newtype DatabaseId = DatabaseId String 31 | deriving (Show) 32 | deriving Var via String 33 | 34 | -- Create a new database identifier. This implementation is 35 | -- *extremely* conservative in what is accepts in the input 36 | -- string. 37 | mkDatabaseId :: String -> Either String DatabaseId 38 | mkDatabaseId s = do 39 | -- Since we don't do any quoting or anything we just need to check 40 | -- if the string obeys all the rules. 41 | s' <- first letters s 42 | s'' <- rest (letters ++ digits) s' 43 | return $ s'' `seq` DatabaseId s 44 | where 45 | rest :: [Char] -> String -> Either String String 46 | rest _ [ ] = Right [ ] 47 | rest choices (c:cs) | c `elem` choices = rest choices cs 48 | rest _ (c:_) = invalid c 49 | 50 | first :: [Char] -> String -> Either String String 51 | first _ [ ] = Left "Database name cannot be empty" 52 | first choices (c:cs) | c `elem` choices = Right cs 53 | first _ (c:_) = invalid c 54 | 55 | invalid c = Left $ "Invalid character '" ++ [c] ++ "' in database name '" ++ s ++ "'" 56 | 57 | letters = "abcdefghjiklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_" 58 | digits = "0123456789" 59 | 60 | -- Unsafe conversion from a String to a DatabaseId. 61 | unsafeMkDatabaseId :: String -> DatabaseId 62 | unsafeMkDatabaseId s = 63 | fromRight (error "bad default") $ mkDatabaseId s 64 | 65 | -- Turn database identifier into an SQL identifier for the 66 | -- database. Will include quotes if necessary. 67 | sqlIdentifier :: DatabaseId -> String 68 | sqlIdentifier (DatabaseId s) = s -- Our whitelist ensures that we do not need any quoting. 69 | 70 | -- Turn database identifier into a RAW identifier for the 71 | -- database. Will NOT include quotes! 72 | unquotedIdentifier :: DatabaseId -> String 73 | unquotedIdentifier (DatabaseId s) = s 74 | -------------------------------------------------------------------------------- /server/src/Tempgres/Mutex.hs: -------------------------------------------------------------------------------- 1 | {- 2 | tempgres, REST service for creating temporary PostgreSQL databases. 3 | Copyright (C) 2014-2020 Bardur Arantsson 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU Affero General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU Affero General Public License for more details. 14 | 15 | You should have received a copy of the GNU Affero General Public License 16 | along with this program. If not, see . 17 | -} 18 | module Tempgres.Mutex 19 | ( Mutex 20 | , mkMutex 21 | , withMutex 22 | ) where 23 | 24 | import Control.Exception (bracket_) 25 | import Control.Concurrent.QSem (QSem, newQSem, waitQSem, signalQSem) 26 | 27 | -- Mutex type 28 | newtype Mutex = Mutex QSem 29 | 30 | -- Creates a mutex based on semaphores. The mutex takes the form a 31 | -- function which can be called with an IO action to perform that 32 | -- action in a critical section. 33 | mkMutex :: IO Mutex 34 | mkMutex = do 35 | semaphore <- newQSem 1 36 | return $ Mutex semaphore 37 | 38 | -- Run a computation in a critical section. 39 | withMutex :: Mutex -> IO a -> IO a 40 | withMutex (Mutex semaphore) action = 41 | bracket_ (waitQSem semaphore) (signalQSem semaphore) action 42 | -------------------------------------------------------------------------------- /server/stack.yaml: -------------------------------------------------------------------------------- 1 | resolver: lts-19.1 2 | packages: 3 | - . 4 | -------------------------------------------------------------------------------- /server/stack.yaml.lock: -------------------------------------------------------------------------------- 1 | # This file was autogenerated by Stack. 2 | # You should not edit this file by hand. 3 | # For more information, please see the documentation at: 4 | # https://docs.haskellstack.org/en/stable/lock_files 5 | 6 | packages: [] 7 | snapshots: 8 | - completed: 9 | size: 617355 10 | url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/19/1.yaml 11 | sha256: cbd5e8593869445794924668479b5bd9f1738d075898623dceacc13b2576b6e3 12 | original: lts-19.1 13 | --------------------------------------------------------------------------------