postmanlabs · Jul 10, 2023 · Jul 10, 2023 · Jul 10, 2023 · Jul 11, 2023 · Jul 11, 2023
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,6 @@
+# Treat each other well
+
+Everyone participating in the _httpbin_ project, and in particular in the issue tracker,
+pull requests, and social media activity, is expected to treat other people with respect
+and more generally to follow the guidelines articulated in the
+[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contribution Guidelines
+
+Before opening any pull requests, please first open an issue describing the
+proposed change. httpbin is currently considered frozen for new features and
+only accepting backwards-compatible bug fixes.
+
+To get the greatest chance of helpful responses, please also observe the
+following additional notes.
+
+## Questions
+
+The GitHub issue tracker is for *bug reports*. Questions about usage should be
+directed to [Stack Overflow](https://stackoverflow.com/).
+
+## Good Bug Reports
+
+Please be aware of the following things when filing bug reports:
+
+1. Avoid raising duplicate issues. *Please* use the GitHub issue search feature
+   to check whether your bug report or feature request has been mentioned in
+   the past. Duplicate bug reports and feature requests are a huge maintenance
+   burden on the limited resources of the project. If it is clear from your
+   report that you would have struggled to find the original, that's ok, but
+   if searching for a selection of words in your issue title would have found
+   the duplicate then the issue will likely be closed extremely abruptly.
+2. When filing bug reports about exceptions or tracebacks, please include the
+   *complete* traceback. Partial tracebacks, or just the exception text, are
+   not helpful. Issues that do not contain complete tracebacks may be closed
+   without warning.
+3. Make sure you provide a suitable amount of information to work with. This
+   means you should provide:
+
+   - Guidance on **how to reproduce the issue**. Ideally, this should be a
+     *small* code sample that can be run immediately by the maintainers.
+     Failing that, let us know what you're doing, how often it happens, what
+     environment you're using, etc. Be thorough: it prevents us needing to ask
+     further questions.
+   - Tell us **what you expected to happen**. When we run your example code,
+     what are we expecting to happen? What does "success" look like for your
+     code?
+   - Tell us **what actually happens**. It's not helpful for you to say "it
+     doesn't work" or "it fails". Tell us *how* it fails: do you get an
+     exception? A hang? A non-200 status code? How was the actual result
+     different from your expected result?
+   - Tell us **what version of httpbin you're using**, and
+     **how you installed it**. Different versions of httpbin behave
+     differently and have different bugs.
+
+   If you do not provide all of these things, it may result in delays
+   with triaging your issue.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,85 @@
+name: Run CI
+
+on: [push, pull_request]
+
+jobs:
+  unit-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "pypy-3.8", "pypy-3.9", "pypy-3.10"]
+        os: [ubuntu-22.04, macOS-latest, windows-latest]
+        # Python 3.8 and 3.9 do not run on macOS-latest which
+        # is now using arm64 hardware.
+        # https://github.com/actions/setup-python/issues/696#issuecomment-1637587760
+        exclude:
+        - { python-version: "3.8", os: "macos-latest" }
+        - { python-version: "3.9", os: "macos-latest" }
+        include:
+        - { python-version: "3.8", os: "macos-13" }
+        - { python-version: "3.9", os: "macos-13" }
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    # from https://github.com/actions/cache/blob/main/examples.md#python---pip
+    - name: Get pip cache dir
+      id: pip-cache
+      shell: bash
+      run: |
+        echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+    - name: pip cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        # the action does not permit updating an existing cache, so we need
+        # unique keys
+        key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.python-version }}-pip-
+    - name: Set up environment & install dependencies
+      run: |
+        python -m pip install pip-tools
+        pip-compile --quiet --generate-hashes --extra mainapp > requirements.txt
+        python -m pip install --use-pep517 --requirement requirements.txt
+        python -m pip install --use-pep517 .[test]
+    - name: Run tests
+      run: python -m pytest tests
+    - name: Store tested requirements.txt file as artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: requirements.txt
+        path: |
+          requirements.txt
+
+  publish-docker-image:
+    runs-on: ubuntu-latest
+    needs: [unit-tests]
+    steps:
+      - name: System Dependencies for Packaging
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python3-pip python3-venv
+          python3 -m venv /tmp/tomlq
+          /tmp/tomlq/bin/pip install --upgrade pip
+          /tmp/tomlq/bin/pip install yq
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set Environment
+        run: |
+          echo "APP_VERSION=$(/tmp/tomlq/bin/tomlq -r .project.version pyproject.toml)" >> $GITHUB_ENV
+          echo "APP_DESC=$(/tmp/tomlq/bin/tomlq -r .project.description pyproject.toml)" >> $GITHUB_ENV
+      - name: Retrieve tested requirements file
+        uses: actions/download-artifact@v3
+        with:
+          name: requirements.txt
+      - name: Ensure docker build is working
+        run: >
+          docker build
+          --build-arg "APP_VERSION=${APP_VERSION}"
+          --build-arg "APP_DESC=${APP_DESC}"
+          .
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,105 @@
+---
+name: Publish
+on: [push]
+permissions:
+  contents: write
+  packages: write
+jobs:
+  unit-tests:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Set up environment & install dependencies
+        run: |
+          python -m pip install pip-tools
+          pip-compile --quiet --generate-hashes --extra mainapp > requirements.txt
+          python -m pip install --requirement requirements.txt
+          python -m pip install .[test]
+      - name: Run tests
+        run: tox
+      - name: Check file contents
+        run: cat requirements.txt
+      - name: Create GitHub Release
+        if: startsWith(github.ref, 'refs/tags/release-')
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            requirements.txt
+            Dockerfile
+      - name: Store tested requirements.txt file as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: requirements.txt
+          path: |
+            requirements.txt
+  publish-docker-image:
+    runs-on: ubuntu-latest
+    needs: [unit-tests]
+    steps:
+      - name: System Dependencies for Packaging
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python3-pip python3-venv
+          python3 -m venv /tmp/tomlq
+          /tmp/tomlq/bin/pip install --upgrade pip
+          /tmp/tomlq/bin/pip install yq
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set Environment
+        run: |
+          echo "APP_VERSION=$(/tmp/tomlq/bin/tomlq -r .project.version pyproject.toml)" >> $GITHUB_ENV
+          echo "APP_DESC=$(/tmp/tomlq/bin/tomlq -r .project.description pyproject.toml)" >> $GITHUB_ENV
+      - name: Retrieve tested requirements file
+        uses: actions/download-artifact@v3
+        with:
+          name: requirements.txt
+      - name: Check file contents
+        run: cat requirements.txt
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: 'arm64'
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to GHCR
+        if: startsWith(github.ref, 'refs/tags/release-')
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and Push Docker Images
+        if: startsWith(github.ref, 'refs/tags/release-')
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          build-args: |
+            APP_VERSION=${{ env.APP_VERSION }}
+            APP_DESC=${{ env.APP_DESC }}
+          tags: |
+            ghcr.io/${{ github.repository }}:${{ env.APP_VERSION }}
+            ghcr.io/${{ github.repository }}:latest
+  pypi-publish:
+    needs: [unit-tests]
+    if: startsWith(github.ref, 'refs/tags/release-')
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/httpbin
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build distribution
+        run: |
+          python -m pip install --upgrade pip build
+          pyproject-build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.gitignore b/.gitignore
@@ -4,8 +4,8 @@ dist/
 .eggs/
 .workon
 .epio-app
-*.pyc
 .tox
+*.pyc
 *.egg-info
 *.swp
 .vscode/
diff --git a/.travis.yml b/.travis.yml
diff --git a/Dockerfile b/Dockerfile
@@ -1,22 +1,48 @@
-FROM ubuntu:18.04
-
-LABEL name="httpbin"
-LABEL version="0.9.2"
-LABEL description="A simple HTTP service."
-LABEL org.kennethreitz.vendor="Kenneth Reitz"
+FROM python:3.10-slim AS build
 
 ENV LC_ALL=C.UTF-8
 ENV LANG=C.UTF-8
+ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt update -y && apt install python3-pip git -y && pip3 install --no-cache-dir pipenv
+RUN apt-get -y update
+RUN apt-get install -y \
+    python3-pip \
+    python3-venv
 
-ADD Pipfile Pipfile.lock /httpbin/
-WORKDIR /httpbin
-RUN /bin/bash -c "pip3 install --no-cache-dir -r <(pipenv lock -r)"
+RUN python3 -m venv /opt/httpbin
+RUN /opt/httpbin/bin/pip install -U pip
+
+ADD requirements.txt /requirements.txt
+RUN /opt/httpbin/bin/pip install --no-deps --requirement /requirements.txt
 
 ADD . /httpbin
-RUN pip3 install --no-cache-dir /httpbin
+RUN /opt/httpbin/bin/pip install --no-deps /httpbin
+
+
+# ----------------------------------------------------------------------------
+
+FROM python:3.10-slim AS prod
+
+ARG APP_VERSION
+LABEL name="httpbin"
+LABEL version=${APP_VERSION}
+LABEL description="A simple HTTP service."
+LABEL org.kennethreitz.vendor="Kenneth Reitz"
+
+RUN useradd \
+    --system \
+    --shell /bin/nologin \
+    --no-create-home \
+    --home /opt/httpbin \
+    httpbin
+
+COPY --from=build /opt/httpbin /opt/httpbin
+WORKDIR /opt/httpbin
 
-EXPOSE 80
+ADD httpbin.bash /opt/httpbin/bin
+RUN chmod +x /opt/httpbin/bin/httpbin.bash
+RUN chown --recursive httpbin /opt/httpbin
+EXPOSE 8080
+CMD ["/opt/httpbin/bin/httpbin.bash"]
 
-CMD ["gunicorn", "-b", "0.0.0.0:80", "httpbin:app", "-k", "gevent"]
+USER httpbin
diff --git a/LICENSE b/LICENSE
@@ -1,15 +1,3 @@
-ISC License
-
-Copyright (c) 2017 Kenneth Reitz.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+This software is made available under the terms of *either* of the licenses
+found in LICENSE.ISC or LICENSE.MIT. Contributions to httpbin are made
+under the terms of *both* these licenses.
diff --git a/LICENSE.ISC b/LICENSE.ISC
@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2017 Kenneth Reitz.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/LICENSE.MIT b/LICENSE.MIT
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2017 Kenneth Reitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.