Explore merging development and CI environments

.asf.yaml

@@ -0,0 +1,73 @@
+# see https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#git.asf.yamlfeatures-GitHubsettings
+
+github:
+  description: "Seamless multi-master syncing database with an intuitive HTTP/JSON API, designed for reliability"
+  homepage: https://couchdb.apache.org/
+  labels:
+    - database
+    - content
+    - network-server
+    - http
+    - cloud
+    - erlang
+    - javascript
+    - couchdb
+    - big-data
+    - network-client
+  features:
+    issues: true
+    projects: true
+  enabled_merge_buttons:
+    squash: true
+    rebase: true
+    merge: true
+  protected_branches:
+    main:
+      required_status_checks:
+        strict: true
+        contexts:
+          - continuous-integration/jenkins/pr-merge
+    3.x:
+      required_status_checks:
+        strict: true
+        contexts:
+          - continuous-integration/jenkins/pr-merge
+    3.1.x:
+      required_status_checks:
+        strict: true
+    3.0.x:
+      required_status_checks:
+        strict: true
+    2.3.x:
+      required_status_checks:
+        strict: true
+    2.1.x:
+      required_status_checks:
+        strict: true
+    2.0.x:
+      required_status_checks:
+        strict: true
+    1.6.x:
+      required_status_checks:
+        strict: true
+    1.5.x:
+      required_status_checks:
+        strict: true
+    1.4.x:
+      required_status_checks:
+        strict: true
+    1.3.x:
+      required_status_checks:
+        strict: true
+    1.x.x:
+      required_status_checks:
+        strict: true
+
+notifications:
+  commits: [email protected]
+  issues: [email protected]
+  pullrequests: [email protected]
+  # This would send new/closed PR notifications to dev@
+  #pullrequests_status: [email protected]
+  # This would send individual PR comments/reviews to notifications@
+  #pullrequests_comment: [email protected]

.credo.exs

@@ -30,6 +30,7 @@
           ~r"/src/jason",
           ~r"/src/hackney",
           ~r"/src/httpotion",
+          ~r"/src/file_system",
           ~r"/src/credo",
           ~r"/src/idna",
           ~r"/src/junit_formatter",
@@ -110,6 +111,7 @@
         {Credo.Check.Readability.StringSigils, []},
         {Credo.Check.Readability.TrailingBlankLine, []},
         {Credo.Check.Readability.TrailingWhiteSpace, []},
+        {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
         {Credo.Check.Readability.VariableNames, []},
 
         #
@@ -119,7 +121,7 @@
         {Credo.Check.Refactor.CyclomaticComplexity, false},
         {Credo.Check.Refactor.FunctionArity, []},
         {Credo.Check.Refactor.LongQuoteBlocks, false},
-        {Credo.Check.Refactor.MapInto, []},
+        {Credo.Check.Refactor.MapInto, false}, # Disabled since not compatible with Elixir > 1.9
         {Credo.Check.Refactor.MatchInCondition, []},
         {Credo.Check.Refactor.NegatedConditionsInUnless, []},
         {Credo.Check.Refactor.NegatedConditionsWithElse, []},
@@ -130,6 +132,7 @@
            excluded_functions: []
          ]},
         {Credo.Check.Refactor.UnlessWithElse, []},
+        {Credo.Check.Refactor.WithClauses, []},
 
         #
         ## Warnings
@@ -138,7 +141,8 @@
         {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
         {Credo.Check.Warning.IExPry, []},
         {Credo.Check.Warning.IoInspect, []},
-        {Credo.Check.Warning.LazyLogging, []},
+        {Credo.Check.Warning.LazyLogging, false}, # Disabled since not compatible with Elixir > 1.9
+        {Credo.Check.Warning.MixEnv, []},
         {Credo.Check.Warning.OperationOnSameValues, []},
         {Credo.Check.Warning.OperationWithConstantResult, []},
         {Credo.Check.Warning.RaiseInsideRescue, []},
@@ -150,10 +154,12 @@
         {Credo.Check.Warning.UnusedRegexOperation, []},
         {Credo.Check.Warning.UnusedStringOperation, []},
         {Credo.Check.Warning.UnusedTupleOperation, []},
+        {Credo.Check.Warning.UnsafeExec, []},
 
         #
         # Controversial and experimental checks (opt-in, just remove `, false`)
         #
+        {Credo.Check.Readability.StrictModuleLayout, false},
         {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
         {Credo.Check.Design.DuplicatedCode, false},
         {Credo.Check.Readability.Specs, false},

.devcontainer/Dockerfile

@@ -0,0 +1,33 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+ARG ERLANG_VSN
+FROM erlang:${ERLANG_VSN}
+
+ARG ERLANG_VSN
+ARG FDB_VSN
+ARG NODE_VSN
+
+# Create Jenkins user and group for usage in CI
+RUN groupadd --gid 910 jenkins; \
+    useradd --uid 910 --gid jenkins --create-home jenkins
+
+COPY install_dependencies.sh /tmp/
+
+RUN ERLANG_VSN=${ERLANG_VSN} FDB_VSN=${FDB_VSN} NODE_VSN=${NODE_VSN} /tmp/install_dependencies.sh
+
+# Allow Jenkins to sudo
+RUN echo "jenkins ALL=(ALL) NOPASSWD: ALL" > /etc/sudoers.d/jenkins
+
+COPY create_cluster_file.bash /usr/local/bin/
+
+CMD sleep infinity

.devcontainer/create_cluster_file.bash

@@ -0,0 +1,57 @@
+#! /bin/bash
+
+#
+# create_cluster_file.bash
+#
+# This source file is part of the FoundationDB open source project
+#
+# Copyright 2013-2018 Apple Inc. and the FoundationDB project authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# This script creates a cluster file for a server or client.
+# This takes the cluster file path from the FDB_CLUSTER_FILE
+# environment variable, with a default of /etc/foundationdb/fdb.cluster
+#
+# The name of the coordinator must be defined in the FDB_COORDINATOR environment
+# variable, and it must be a name that can be resolved through DNS.
+
+function create_cluster_file() {
+	FDB_CLUSTER_FILE=${FDB_CLUSTER_FILE:-/etc/foundationdb/fdb.cluster}
+	mkdir -p $(dirname $FDB_CLUSTER_FILE)
+
+	if [[ -n "$FDB_CLUSTER_FILE_CONTENTS" ]]; then
+		echo "$FDB_CLUSTER_FILE_CONTENTS" > $FDB_CLUSTER_FILE
+	elif [[ -n $FDB_COORDINATOR ]]; then
+		coordinator_ip=$(getent hosts $FDB_COORDINATOR | awk {'print $1'})
+		x=$(getent hosts $FDB_COORDINATOR)
+		y=$(getent hosts fdb)
+		echo "Output of getent: ${x}"
+		echo "Output of getent raw: ${y}"
+		echo "coordinator_ip: ${coordinator_ip}"
+		if [[ -z "$coordinator_ip" ]]; then
+			echo "Failed to look up coordinator address for $FDB_COORDINATOR" 1>&2
+			exit 1
+		fi
+		coordinator_port=${FDB_COORDINATOR_PORT:-4500}
+		echo "docker:docker@$coordinator_ip:$coordinator_port" > $FDB_CLUSTER_FILE
+	else
+		echo "FDB_COORDINATOR environment variable not defined" 1>&2
+		exit 1
+	fi
+}
+
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+	create_cluster_file "$@"
+fi

.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+{
+    "dockerComposeFile": "docker-compose.yaml",
+    "service": "couch",
+    "workspaceFolder": "/usr/src/couchdb",
+
+    // Needs to run at start to translate service name into coordinator IP
+    "postStartCommand": ["bash", "/usr/local/bin/create_cluster_file.bash"],
+
+    "extensions": [
+        "erlang-ls.erlang-ls"
+    ]
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,53 @@
+services:
+  couch:
+    # Select a pre-built image hosted on GHCR
+    # image: ghcr.io/apache/couchdb:devcontainer-erlang-24-fdb-6.3.23
+
+    # Alternatively, build your own image on-demand
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        # The Erlang version determines our base image, which means it
+        # implicitly selects versions for ICU + SpiderMonkey as well.
+        ERLANG_VSN: "24"
+
+        # This selects the FoundationDB client version. Typically you'd
+        # want it to match the server version in fdb.image below.
+        FDB_VSN: "6.3.23"
+
+        # The Fauxton UI has a Node.js build-time dependency, most of
+        # the time there's no reason to change this.
+        NODE_VSN: "14"
+
+    environment:
+      # This needs to match the name of the FoundationDB service below
+      FDB_COORDINATOR: fdb
+
+      # The location where the FDB cluster file is created on container
+      # startup. CouchDB looks for the cluster file in this location by
+      # default. If you want to install it somewhere else you need to
+      # change "[erlfdb] cluster_file" and ERL_ZFLAGS to match.
+      FDB_CLUSTER_FILE: /usr/local/etc/foundationdb/fdb.cluster
+
+      # The test suite will default to trying to start its own fdbserver
+      # process. This environment variable tells it to use the fdbserver
+      # running in the `fdb` image instead. Quite a hacky solution. An
+      # alternative might be to parameterize the Makefile so we can swap
+      # `eunit.config` for a `devcontainer.config` via an environment variable
+      # and maintain both config files in the repo.
+      ERL_ZFLAGS: "-erlfdb test_cluster_file <<\\\"/usr/local/etc/foundationdb/fdb.cluster\\\">>"
+
+    volumes:
+      # Mounts the project folder to '/usr/src/couchdb'. The target path inside
+      # the container should match what your application expects. In this case,
+      # the compose file is in a sub-folder, so you will mount '..'. You would
+      # then reference this path as the 'workspaceFolder' in
+      # '.devcontainer/devcontainer.json' so VS Code starts here.
+      - ..:/usr/src/couchdb:cached
+
+    network_mode: service:fdb
+
+  fdb:
+    # This is the version of the FDB server that will run alongside CouchDB
+    image: foundationdb/foundationdb:6.3.23

.devcontainer/install_dependencies.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -ex
+
+. /etc/os-release 2>/dev/null || true
+
+# Choose Elixir version automatically based on Erlang version
+if [ -z ${ELIXIR_VSN} ]; then
+    if [[ ${ERLANG_VSN} =~ ^20 ]]; then
+        ELIXIR_VSN='v1.9.4'
+    elif [[ ${ERLANG_VSN} =~ ^21 ]]; then
+        ELIXIR_VSN='v1.11.4'
+    elif [[ ${ERLANG_VSN} =~ ^2[234] ]]; then
+        ELIXIR_VSN='v1.12.3'
+    else
+        ELIXIR_VSN='v1.13.3'
+    fi
+fi
+
+# SpiderMonkey likes to bake the version into the package name
+if [ "${VERSION_CODENAME}" == "stretch" ]; then
+    # We provide our own build of SM 1.8.5 for ancient distros
+    curl https://couchdb.apache.org/repo/keys.asc | gpg --dearmor | tee /usr/share/keyrings/couchdb-archive-keyring.gpg >/dev/null 2>&1
+    echo "deb [signed-by=/usr/share/keyrings/couchdb-archive-keyring.gpg] https://apache.jfrog.io/artifactory/couchdb-deb/ stretch main" \
+    | tee /etc/apt/sources.list.d/couchdb.list >/dev/null
+    spidermonkey_pkg='couch-libmozjs185-dev'
+elif [ "${VERSION_CODENAME}" == "buster" ]; then
+    spidermonkey_pkg='libmozjs-60-dev'
+elif [ "${VERSION_CODENAME}" == "bullseye" ]; then
+    spidermonkey_pkg='libmozjs-78-dev'
+fi
+
+# Activate NodeSource repo for Node.js (Fauxton dependency)
+wget -q https://deb.nodesource.com/setup_${NODE_VSN}.x
+/bin/bash setup_${NODE_VSN}.x
+rm setup_${NODE_VSN}.x
+
+apt-get install --no-install-recommends -y \
+    sudo \
+    dnsutils \
+    python3-pip \
+    python3-sphinx \
+    python3-venv \
+    libicu-dev \
+    $spidermonkey_pkg \
+    nodejs
+
+npm install npm@latest -g --unsafe-perm
+
+# Documentation theme
+pip3 install sphinx_rtd_theme
+
+# Elixir
+wget -q https://github.com/elixir-lang/elixir/releases/download/${ELIXIR_VSN}/Precompiled.zip
+unzip -qq Precompiled.zip -d /usr/local
+rm Precompiled.zip
+
+# FoundationDB client
+wget -q https://github.com/apple/foundationdb/releases/download/${FDB_VSN}/foundationdb-clients_${FDB_VSN}-1_amd64.deb
+dpkg -i ./foundationdb*deb
+rm -rf ./foundationdb*deb
+
+apt-get clean

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: true
+contact_links:
+    - name: File a Fauxton bug
+      url: https://github.com/apache/couchdb-fauxton/issues/new
+      about: Any web UI bugs should be filed in the Fauxton repo.
+    - name: File a documentation bug
+      url: https://github.com/apache/couchdb-documentation/issues/new
+      about: Any documentation bugs should be filed in our docs repo.
+    - name: Ask a Question
+      url: https://github.com/apache/couchdb/discussions/category_choices
+      about: If you're not specifically reporting a bug, please ask your question here.
+    - name: Read the Documentation
+      url: https://docs.couchdb.org/
+      about: You can also check out our excellent documentation here.