Add working example and test case for diesel

Fixes #27, or at least works around it.

This deals with the issues mentioned in
sgrif/pq-sys#18, and it relies heavily on ideas
from @golddranks and @clux.

Author: emk

.gitignore

@@ -0,0 +1 @@
+target

Dockerfile

@@ -19,7 +19,11 @@ RUN apt-get update && \
         curl \
         file \
         git \
+        musl-dev \
         musl-tools \
+        libpq-dev \
+        libssl-dev \
+        pkgconf \
         sudo \
         xutils-dev \
         && \
@@ -58,7 +62,7 @@ RUN echo "Building OpenSSL" && \
     VERS=1.0.2l && \
     curl -O https://www.openssl.org/source/openssl-$VERS.tar.gz && \
     tar xvzf openssl-$VERS.tar.gz && cd openssl-$VERS && \
-    env CC=musl-gcc ./config --prefix=/usr/local/musl && \
+    env CC=musl-gcc ./Configure no-shared no-zlib -fPIC --prefix=/usr/local/musl linux-x86_64 && \
     env C_INCLUDE_PATH=/usr/local/musl/include/ make depend && \
     make && sudo make install && \
     cd .. && rm -rf openssl-$VERS.tar.gz openssl-$VERS && \
@@ -76,17 +80,19 @@ RUN echo "Building OpenSSL" && \
     tar xzf postgres.tar.gz && \
     cd postgresql-$VERS && \
     CC=musl-gcc CPPFLAGS=-I/usr/local/musl/include LDFLAGS=-L/usr/local/musl/lib ./configure --with-openssl --without-readline --prefix=/usr/local/musl && \
-    cd src/interfaces/libpq && \
-    make all-static-lib && sudo make install-lib-static && \
-    cd ../../../.. && rm -rf postgres.tar.gz postgresql-$VERS
+    cd src/interfaces/libpq && make all-static-lib && sudo make install-lib-static && cd ../../.. && \
+    cd src/bin/pg_config && make && sudo make install && cd ../.. && \
+    cd .. && rm -rf postgres.tar.gz postgresql-$VERS
 
 ENV OPENSSL_DIR=/usr/local/musl/ \
     OPENSSL_INCLUDE_DIR=/usr/local/musl/include/ \
     DEP_OPENSSL_INCLUDE=/usr/local/musl/include/ \
     OPENSSL_LIB_DIR=/usr/local/musl/lib/ \
     OPENSSL_STATIC=1 \
-    PQ_LIB_DIR=/usr/local/musl/lib \
-    PQ_LIB_STATIC=1
+    PQ_LIB_STATIC_X86_64_UNKNOWN_LINUX_MUSL=1 \
+    PG_CONFIG_X86_64_UNKNOWN_LINUX_GNU=/usr/bin/pg_config \
+    PKG_CONFIG_ALLOW_CROSS=true \
+    PKG_CONFIG_ALL_STATIC=true
 
 # (Please feel free to submit pull requests for musl-libc builds of other C
 # libraries needed by the most popular and common Rust crates, to avoid

README.md

@@ -2,33 +2,26 @@
 
 [![Docker Image](https://img.shields.io/docker/pulls/ekidd/rust-musl-builder.svg?maxAge=2592000)](https://hub.docker.com/r/ekidd/rust-musl-builder/)
 
-Do you want to compile a completely static Rust binary with no external
-dependencies?  If so, try:
+Do you want to compile a completely static Rust binary with no external dependencies?  If so, try:
 
 ```sh
 alias rust-musl-builder='docker run --rm -it -v "$(pwd)":/home/rust/src ekidd/rust-musl-builder'
 rust-musl-builder cargo build --release
 ```
 
-This command assumes that `$(pwd)` is readable and writable by uid 1000,
-gid 1000.  It will output binaries in
-`target/x86_64-unknown-linux-musl/release`.  At the moment, it doesn't
-attempt to cache libraries between builds, so this is best reserved for
-making final release builds.
+This command assumes that `$(pwd)` is readable and writable by uid 1000, gid 1000.  It will output binaries in `target/x86_64-unknown-linux-musl/release`.  At the moment, it doesn't attempt to cache libraries between builds, so this is best reserved for making final release builds.
 
 ## Deploying your Rust application
 
 With a bit of luck, you should be able to just copy your application binary from `target/x86_64-unknown-linux-musl/release`, and install it directly on any reasonably modern x86_64 Linux machine.  In particular, you should be able make static release binaries using TravisCI and GitHub, or you can copy your Rust application into an [Alpine Linux container][]. See below for details!
 
 ## How it works
 
-`rust-musl-builder` uses [musl-libc][], [musl-gcc][], and the new
-[rustup][] `target` support.  It includes static versions of several
-libraries:
+`rust-musl-builder` uses [musl-libc][], [musl-gcc][], and the new [rustup][] `target` support.  It includes static versions of several libraries:
 
 - The standard `musl-libc` libraries.
 - OpenSSL, which is needed by many Rust applications.
-- `libpq`, which is needed for applications that use `diesel` with PostgreSQL.
+- `libpq`, which is needed for applications that use `diesel` with PostgreSQL. Note that this may be broken under Rust 1.21.0 and later (see https://github.com/emk/rust-musl-builder/issues/27).
 - `libz`, which is needed by `libpq`.
 
 This library also sets up the environment variables needed to compile popular Rust crates using these libraries.
@@ -46,14 +39,28 @@ fn main() {
 }
 ```
 
+## Making Diesel work
+
+In addition to setting up OpenSSL, you'll need to add the following lines to your `Cargo.toml`:
+
+```toml
+[dependencies]
+# This is needed to make sure that Cargo statically links against
+# `libssl`. This should happen automatically, but it doesn't.
+openssl-sys = "0.9"
+
+[patch.crates-io]
+# This is needed to handle cross-compilation of libpq.
+pq-sys = { git = 'https://github.com/golddranks/pq-sys' }
+```
+
+See [this PR](https://github.com/sgrif/pq-sys/pull/18) for a discussion of the issues involved in cross-compiling `diesel` and `diesel_codegen`.
+
 ## Making static releases with Travis CI and GitHub
 
 These instructions are inspired by [rust-cross][].
 
-First, read the [Travis CI: GitHub Releases Uploading][uploading] page, and
-run `travis setup releases` as instructed.  Then add the following lines to
-your existing `.travis.yml` file, replacing `myapp` with the name of your
-package:
+First, read the [Travis CI: GitHub Releases Uploading][uploading] page, and run `travis setup releases` as instructed.  Then add the following lines to your existing `.travis.yml` file, replacing `myapp` with the name of your package:
 
 ```yaml
 language: rust
@@ -78,13 +85,9 @@ deploy:
     tags: true
 ```
 
-Next, copy [`build-release`](./examples/build-release) into your project
-and run `chmod +x build-release`.
+Next, copy [`build-release`](./examples/build-release) into your project and run `chmod +x build-release`.
 
-When you push a new tag to your project, `build-release` will automatically
-build new Linux binaries using `rust-musl-builder`, and new Mac binaries
-with Cargo, and it will upload both to the GitHub releases page for your
-repository.
+When you push a new tag to your project, `build-release` will automatically build new Linux binaries using `rust-musl-builder`, and new Mac binaries with Cargo, and it will upload both to the GitHub releases page for your repository.
 
 For a working example, see [faradayio/cage][cage].
 
@@ -94,49 +97,26 @@ For a working example, see [faradayio/cage][cage].
 
 ## Making tiny Docker images with Alpine Linux and Rust binaries
 
-Docker now supports [multistage builds][multistage], which make it easy to
-build your Rust application with `rust-musl-builder` and deploy it using
-[Alpine Linux][]. For a working example, see
-[`Dockerfile.multistage-example`](./Dockerfile.multistage-example).
+Docker now supports [multistage builds][multistage], which make it easy to build your Rust application with `rust-musl-builder` and deploy it using [Alpine Linux][]. For a working example, see [`examples/using-diesel/Dockerfile`](./examples/using-diesel/Dockerfile).
 
 [multistage]: https://docs.docker.com/engine/userguide/eng-image/multistage-build/
 [Alpine Linux]: https://alpinelinux.org/
 
 ## Adding more C libraries
 
-If you're using Docker crates which require specific C libraries to be
-installed, you can create a `Dockerfile` based on this one, and use
-`musl-gcc` to compile the libraries you need.  For example:
-
-```Dockerfile
-FROM ekidd/rust-musl-builder
-
-# EXAMPLE ONLY! libz is already included.
-RUN VERS=1.2.11 && \
-    cd /home/rust/libs && \
-    curl -LO http://zlib.net/zlib-$VERS.tar.gz && \
-    tar xzf zlib-$VERS.tar.gz && cd zlib-$VERS && \
-    CC=musl-gcc ./configure --static --prefix=/usr/local/musl && \
-    make && sudo make install && \
-    cd .. && rm -rf zlib-$VERS.tar.gz zlib-$VERS
-```
-
-This usually involves a bit of experimentation for each new library, but it
-seems to work well for most simple, standalone libraries.
+If you're using Docker crates which require specific C libraries to be installed, you can create a `Dockerfile` based on this one, and use `musl-gcc` to compile the libraries you need.  For an example, see [`examples/adding-a-library/Dockerfile`](./examples/adding-a-library/Dockerfile). This usually involves a bit of experimentation for each new library, but it seems to work well for most simple, standalone libraries.
 
-If you need an especially common library, please feel free to submit a pull
-request adding it to the main `Dockerfile`!  We'd like to support popular
-Rust crates out of the box.
+If you need an especially common library, please feel free to submit a pull request adding it to the main `Dockerfile`!  We'd like to support popular Rust crates out of the box.
 
 ## Development notes
 
-After modifying the image, run `./test-image` to make sure that everything
-works.
+After modifying the image, run `./test-image` to make sure that everything works.xs
 
 ## Other ways to build portable Rust binaries
 
 - [messense/rust-musl-cross](https://github.com/messense/rust-musl-cross) shows how to build binaries for many different architectures.
 - [japaric/rust-cross](https://github.com/japaric/rust-cross) has extensive instructions on how to cross-compile Rust applications.
+- [clux/muslrust](https://github.com/clux/muslrust) also supports libcurl.
 
 ## License
 

examples/adding-a-library/.dockerignore

@@ -0,0 +1 @@
+target

Dockerfile.example renamed to examples/adding-a-library/Dockerfile

@@ -0,0 +1 @@
+target