pact_broker 2.89.1 → 2.90.0

data/docs/configuration.yml

@@ -1,385 +0,0 @@
-groups:
-  - title: Logging
-    vars:
-      log_level:
-        description: "The application log level"
-        default_value: info
-        allowed_values:
-          - debug
-          - info
-          - warn
-          - error
-          - fatal
-      log_format:
-        description: "The application log format. Can be any value supported by Semantic Logger."
-        default_value: "default"
-        allowed_values:
-          - default
-          - json
-          - color
-        more_info: https://github.com/rocketjob/semantic_logger/tree/master/lib/semantic_logger/formatters
-      log_dir:
-        description: "The log file directory"
-        default_value: "./logs"
-      log_stream:
-        description: |-
-          The stream to which the logs will be sent.
-
-          While the default is `file` for the Ruby application, it is set to `stdout` on the supported Docker images.
-        default_value: "file"
-        allowed_values:
-          - stdout
-          - file
-      hide_pactflow_messages:
-        description: "Set to `true` to hide the messages in the logs about Pactflow"
-        default_value: true
-        allowed_values:
-          - true
-          - false
-        more_info: https://pactflow.io
-  - title: Database
-    vars:
-      database_adapter:
-        description: |-
-          The database adapter. For production use, Postgres must be used.
-
-          For investigations/spikes on a development machine, you can use SQlite. It is not supported as a production database, as it does not support
-          concurrent requests.
-        default_value: "postgres"
-        allowed_values:
-          - postgres (for production use)
-          - sqlite (for spikes only)
-      database_username:
-        description: "The database username"
-      database_password:
-        description: "The database password"
-      database_name:
-        description: "The database name. If using the `sqlite` adapter, this will be the path to the database file."
-        examples:
-          - pact_broker
-          - /tmp/pact_broker.sqlite3
-          - ./tmp/pact_broker.sqlite3
-      database_host:
-        description: "The database host"
-      database_port:
-        description: "The database port. If ommited, the default port for the adapter will be used."
-      database_url:
-        description: |-
-          The full database URL may be specified instead of the separate adapter, username, password, name, host and port.
-        format: "`{database_adapter}://{database_username}:{database_password}@{database_host}:{database_port}/{database_name}`"
-        examples:
-          - postgres://pact_broker_user:pact_broker_password@pact_broker_db_host/pact_broker
-          - sqlite:///tmp/pact_broker.sqlite3 (relative path to working directory)
-          - sqlite:////tmp/pact_broker.sqlite3 (absolute path)
-      database_sslmode:
-        description: The Postgresql ssl mode.
-        default_value: prefer
-        allowed_values:
-          - disable
-          - allow
-          - prefer
-          - require
-          - verify-ca
-          - verify-full
-        more_info: https://ankane.org/postgres-sslmode-explained
-      sql_log_level:
-        description: |-
-          The log level that will be used when the SQL query statements are logged.
-
-          To disable noisy SQL query logging when the application `log_level` is set to `debug` for other reasons, use the value `none`.
-        default_value: debug
-        allowed_values:
-          - none
-          - debug
-          - info
-          - warn
-          - error
-          - fatal
-      sql_log_warn_duration:
-        description: "The number of seconds after which to log an SQL query at warn level. Use this for detecting slow queries."
-        default_value: 5
-        allowed_values_description: A positive integer or float, as a string.
-        more_info: https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options
-      database_max_connections:
-        description: "The maximum size of the connection pool (4 connections by default on most databases)"
-        default_value: 4
-        allowed_values_description: A positive integer value.
-        more_info: https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options
-      database_pool_timeout:
-        description: "The number of seconds to wait if a connection cannot be acquired before raising an error"
-        default_value: 5
-        allowed_values_description: A positive integer.
-        more_info: https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options
-      database_connect_max_retries:
-        description: |-
-          When running the Pact Broker Docker image experimentally using Docker Compose on a local development machine,
-          the Broker application process may be ready before the database is available for connection, causing the application
-          container to exit with an error. Setting the max retries to a non-zero number will allow it to retry the connection the
-          configured number of times, waiting 3 seconds between attempts.
-        default_value: 0
-        allowed_values_description: A positive integer value.
-      auto_migrate_db:
-        description: "Whether or not to run the database schema migrations on start up. It is recommended to set this to `true`."
-        default_value: true
-        allowed_values:
-          - true
-          - false
-      auto_migrate_db_data:
-        description: "Whether or not to run the database data migrations on start up. It is recommended to set this to `true`."
-        default_value: true
-        allowed_values:
-          - true
-          - false
-      allow_missing_migration_files:
-        description: |-
-          If `true`, will not raise an error if a database migration is recorded in the database that does not have an
-          equivalent file in the codebase. If this is true, an older version of the code may be used with a newer version of the database,
-          however, data integrity issues may occur.
-        default_value: true
-        allowed_values:
-        more_info: https://sequel.jeremyevans.net/rdoc/classes/Sequel/Migrator.html
-      database_statement_timeout:
-        description: "The number of seconds after which an SQL query will be aborted. Only supported for Postgresql connections."
-        default_value: 15
-        allowed_values_description: A positive integer or float.
-        more_info: https://www.postgresql.org/docs/9.3/runtime-config-client.html
-      metrics_sql_statement_timeout:
-        description: |-
-          The number of seconds after which the SQL queries used for the metrics endpoint will be aborted.
-          This is configurable separately from the standard `database_statement_timeout` as it may need to be significantly
-          longer than the desired value for standard queries.
-        default_value: 30
-        allowed_values_description: A positive integer.
-      database_connection_validation_timeout:
-        description: |-
-          The number of seconds after which to check the health of a connection from a connection pool before passing it to the application.
-
-          `-1` means that connections will be validated every time, which avoids errors
-          when databases are restarted and connections are killed.  This has a performance
-          penalty, so consider increasing this timeout if building a frequently accessed service.
-
-        default_description: -1 for v2.85.1 and earlier, 3600 for later versions.
-        allowed_values_description: -1 or any positive integer.
-        more_info: https://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/connection_validator_rb.html
-  - title: Authentication and authorization
-    comments: |
-      The Pact Broker comes with 2 configurable basic auth users - one with read/write privileges, and one with read only privileges.
-      The read only credentials should be distributed to the developers for use from development machines, and the read/write credentials
-      should be used for CI/CD.
-    vars:
-      basic_auth_enabled:
-        description: "Whether to enable basic authorization. This is automatically set to true for the Docker images if the `basic_auth_username` and `basic_auth_password` are set."
-        default_value: false
-        allowed_values:
-          - true
-          - false
-      basic_auth_username:
-        description: "The username for the read/write basic auth user."
-      basic_auth_password:
-        description: "The password for the read/write basic auth user."
-      basic_auth_read_only_username:
-        description: "The username for the read only basic auth user."
-      basic_auth_read_only_password:
-        description: "The password for the read only basic auth user."
-      allow_public_read:
-        description: "If you want to allow public read access, but still require credentials for writing, then leave `basic_auth_read_only_username` and `basic_auth_read_only_password` unset, and set `allow_public_read` to `true`."
-        default_value: false
-        allowed_values:
-          - true
-          - false
-      public_heartbeat:
-        description: "If you have enabled basic auth, but require unauthenticated access to the heartbeat URL (eg. for use within an AWS autoscaling group), set `public_heartbeat` to `true`."
-        default_value: false
-        allowed_values:
-          - true
-          - false
-      enable_public_badge_access:
-        description: "Set this to true to allow status badges to be embedded in README files without requiring a hardcoded password."
-        default_value: false
-        allowed_values:
-          - true
-          - false
-  - title: Webhooks
-    vars:
-      webhook_retry_schedule:
-        description: |-
-          The schedule of seconds to wait between webhook execution attempts.
-          The default schedule is 10 sec, 1 min, 2 min, 5 min, 10 min, 20 min (38 minutes in total).
-        default_value: "10 60 120 300 600 1200"
-        format: A space separated list of integers.
-      webhook_http_method_whitelist:
-        description: |-
-          The allowed HTTP methods for webhooks.
-          It is highly recommended that only `POST` requests are allowed to ensure that webhooks cannot be used to retrieve sensitive information from hosts within the same network.
-        default_value: "POST"
-        format: A space separated list.
-        allowed_values:
-          - POST
-          - GET (not recommended)
-          - PUT (not recommended)
-          - PATCH (not recommended)
-          - DELETE (not recommended)
-      webhook_http_code_success:
-        description: |-
-          If webhook call returns the response with an HTTP code that is listed in the success codes then the operation is
-          considered a success, otherwise the webhook will be re-triggered based on the `webhook_retry_schedule` configuration.
-
-          In most cases, configuring this is not necessary, but there are some CI systems that return a non 200 status for a success,
-          which is why this feature exists.
-        default_value: "200 201 202 203 204 205 206"
-        format: A space separated list of integers.
-        allowed_values:
-          - Any valid HTTP status code
-      webhook_scheme_whitelist:
-        description: "The allowed URL schemes for webhooks."
-        default_value: "https"
-        format: "A space delimited list."
-        allowed_values:
-          - https
-          - http
-      webhook_host_whitelist:
-        description: |-
-          A list of hosts, network ranges, or host regular expressions.
-          Regular expressions should start and end with a `/` to differentiate them from Strings.
-          Note that backslashes need to be escaped with a second backslash when setting via an environment variable.
-          Please read the [Webhook whitelists section](https://docs.pact.io/pact_broker/configuration/features#webhooks) of the Pact Broker configuration documentation to understand how the whitelist is used.
-        default_value:
-        examples:
-          - github.com
-          - 10.2.3.41/24
-          - /.*\\.foo\\.com$/
-        more_info: https://docs.pact.io/pact_broker/configuration/#webhook-whitelists
-      disable_ssl_verification:
-        description: "If set to true, SSL verification will be disabled for the HTTP requests made by the webhooks"
-        default_value: false
-        allowed_values:
-          - true
-          - false
-      user_agent:
-        description: |-
-          The user agent to set when making HTTP requests for webhooks.
-        default_value: "Pact Broker v{VERSION}"
-  - title: Resources
-    vars:
-      port:
-        description: |-
-          The HTTP port that the Pact Broker application will run on. This will only be honoured if you are deploying the Pact Broker using
-          a package that actually reads this property (eg. one of the supported Docker images). If you are running the vanilla Ruby application,
-          the application will run on the port the server has been configured to run on (eg. `bundle exec rackup -p 9393`)
-        default_value: 9292
-      base_url:
-        description: |-
-          The full URL (including port, if non-standard for the protocol) at which the application will be made available to users.
-          This is used to create the links in the API.
-          The application may run correctly without this attribute, however, it is strongly recommended to set it when
-          deploying the Pact Broker to production as it prevents cache poisoning security vulnerabilities.
-          It is also required when deploying the Broker behind a reverse proxy, and when the application has been mounted at a non-root context.
-          Note that this attribute does not change where the application is actually mounted (that is the concern of the deployment configuration) - it just changes the links.
-        examples:
-          - https://pact-broker.mycompany.com
-          - https://my-company.com:9292/pact-broker
-      base_urls:
-        description: |-
-          An alias of base_url. From version 2.79.0, multiple base URLs can be configured for architectures that use
-          gateways or proxies that allow the same Pact Broker instance to be addressed with different base URLs.
-        format: A space separated list.
-        example: "http://my-internal-pact-broker:9292 https://my-external-pact-broker"
-      shields_io_base_url:
-        description: The URL of the shields.io server used to generate the README badges.
-        default_value: https://img.shields.io
-        more_info: https://shields.io
-      badge_provider_mode:
-        description: |-
-          The method by which the badges are generated. When set to `redirect`, a request to the Pact Broker for a badge will be sent a redirect response
-          to render the badge from the shields.io server directly in the browser. This is the recommended value.
-          When set to `proxy`, the Pact Broker will make a request directly to the configured shields.io server, and then send the returned file
-          back to the browser. This mode is not recommended for security and performance reasons.
-        default_value: redirect
-        allowed_values:
-          - redirect
-          - proxy
-      enable_diagnostic_endpoints:
-        description: |-
-          Whether or not to enable the diagnostic endpoints at `/diagnostic/status/heartbeat` and `"diagnostic/status/dependencies`.
-          The heartbeat endpoint is for use by load balancers, and the dependencies endpoint is for checking that the database
-          is available (do not use this for load balancing, as it makes a database connection).
-        default_value: true
-        allowed_values:
-          - true
-          - false
-  - title: Domain
-    vars:
-      check_for_potential_duplicate_pacticipant_names:
-        description: |-
-          When a pact is published, the consumer, provider and consumer version resources are automatically created.
-
-          To prevent a pacticipant (consumer or provider) being created multiple times with slightly different name variants
-          (eg. FooBar/foo-bar/foo bar/Foo Bar Service), a check is performed to determine if a new pacticipant name is likely to be a duplicate
-          of any existing applications. If it is deemed similar enough to an existing name, a 409 will be returned.
-
-          The response body will contain instructions indicating that the pacticipant name should be corrected if it was intended to be an existing one,
-          or that the pacticipant should be created manually if it was intended to be a new one.
-
-          To turn this feature off, set `check_for_potential_duplicate_pacticipant_names` to `false`, and make sure everyone is very careful with their naming!
-          The usefulness of the Broker depends on the integrity of the data, which in turn depends on the correctness of the pacticipant names.
-        default_value: true
-        allowed_values:
-          - true
-          - false
-        more_info: null
-      create_deployed_versions_for_tags:
-        description: |-
-          When `create_deployed_versions_for_tags` is `true` and a tag is created, if there is an environment with the name of the newly created tag, a deployed version is
-          also created for the pacticipant version.
-
-          This is to assist in the migration from using tags to track deployments to using the deployed and released versions feature.
-        supported_versions: From v2.81.0
-        default_value: true
-        allowed_values:
-          - true
-          - false
-        more_info: https://docs.pact.io/pact_broker/recording_deployments_and_releases/
-      use_first_tag_as_branch:
-        description: |-
-          When `use_first_tag_as_branch` is `true`, the first tag applied to a version within the `use_first_tag_as_branch_time_limit` (10 seconds)
-          will be used to populate the `branch` property of the version.
-
-          This is to assist in the migration from using tags to track branches to using the branches feature.
-        supported_versions: From v2.82.0
-        default_value: true
-        allowed_values:
-          - true
-          - false
-      auto_detect_main_branch:
-        description: |-
-          When `true` and a pacticipant version is created with a tag or a branch that matches one of the names in `main_branch_candidates`,
-          the `mainBranch` property is set for that pacticipant if it is not already set.
-
-          This is to assist in the migration from using tags to track branches to using the branches feature.
-        supported_versions: From v2.82.0
-        default_value: true
-        allowed_values:
-          - true
-          - false
-      main_branch_candidates:
-        description: |-
-          An array of potential main branch names used when automatically detecting the main branch for a pacticipant.
-        format: "A space delimited list."
-        default_value: "develop main master"
-        supported_versions: From v2.82.0
-      allow_dangerous_contract_modification:
-        description: |-
-          Whether or not to allow the pact content for an existing consumer version to be modified. It is strongly recommended that this is set to false,
-          as allowing modification makes the results of can-i-deploy unreliable. When this is set to false as recommended, each commit must publish pacts
-          with a unique version number.
-        default_description: For new installations of v2.82.0 and later, this defaults to `false`.
-        supported_versions: From v2.82.0
-        allowed_values:
-          - true
-          - false
-        more_info: https://docs.pact.io/versioning
-  - title: Miscellaneous
-    vars:
-      features:
-        description: A list of features to enable in the Pact Broker for beta testing before public release.
-        format: A space separated list.

data/example/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gem "pact_broker", path: "../"
-gem "sqlite3", "~>1.3" # Sqlite is just for testing. Replace this with "pg" for production.
-gem "pg" # Production database gem
-gem "puma", "~> 5.3" # Can be replaced with your choice of application server

data/example/README.md

@@ -1,64 +0,0 @@
-# Run Pact Broker example
-
-It is recommended to use the [Docker Pact Broker image][docker-pact-broker] for production use.
-
-Clone project
-
-```bash
-git clone https://github.com/pact-foundation/pact_broker
-```
-
-Change directory to `example`
-
-```bash
-cd pact_broker/example
-```
-
-## Run with sqlite database
-
-Install dependencies
-
-```bash
-bundle install
-```
-
-Run Pact Broker
-
-```bash
-bundle exec puma
-```
-
-Now Pact Broker can be access locally at [http://localhost:9292](http://localhost:9292).
-
-## Run with postgres database
-
-Create a postgres database
-
-```bash
-psql postgres -c "CREATE DATABASE pact_broker;"
-psql postgres -c "CREATE ROLE pact_broker WITH LOGIN PASSWORD 'pact_broker';"
-psql postgres -c "GRANT ALL PRIVILEGES ON DATABASE pact_broker TO pact_broker;"
-```
-
-Uncomment `gem 'pg'` in the [Gemfile](Gemfile)
-
-Comment out `gem 'sqlite3'` in the [Gemfile](Gemfile)
-
-Replace the `database_url` in `config/pact_broker.yml` with `postgres://pact_broker:pact_broker@<YOUR_DB_HOST>/pact_broker`
-
-Install dependencies
-
-```bash
-bundle install
-```
-
-Run Pact Broker
-
-```bash
-bundle exec puma
-```
-
-Now Pact Broker can be access locally at [http://localhost:9292](http://localhost:9292).
-
-[docker-pact-broker]: https://github.com/pact-foundation/pact-broker-docker
-[pact-broker-dir]: https://github.com/pact-foundation/pact-broker-docker/tree/master/pact_broker

data/example/config/pact_broker.yml

@@ -1,9 +0,0 @@
-port: 9292
-log_dir: null
-log_level: info
-basic_auth_enabled: false # set to true to enable the user below
-basic_auth_username: "user"
-basic_auth_password: "pass"
-basic_auth_read_only_username: "rouser"
-basic_auth_read_only_password: "ropass"
-database_url: sqlite:////tmp/pact_broker.sqlite3

data/example/config/puma.rb

@@ -1,3 +0,0 @@
-require "pact_broker/configuration"
-
-port PactBroker.configuration.port

data/example/config.ru

@@ -1,10 +0,0 @@
-require "pact_broker"
-
-ENV["RACK_ENV"] ||= "production"
-ENV["TZ"] = "Australia/Melbourne" # Set the timezone you want your dates to appear in
-
-app = PactBroker::App.new do | config |
-  config.log_configuration
-end
-
-run app

data/issue-reproduction/Dockerfile-pact-broker

@@ -1,42 +0,0 @@
-FROM ruby:2.7-alpine
-
-RUN apk update \
-    && apk --no-cache add \
-      "build-base>=0.5" \
-      "bash>=4.4" \
-      "ca-certificates>=20190108" \
-      "git>=2.20" \
-      "postgresql-dev>=11.3" \
-      "sqlite-dev>=3.28" \
-      "sqlite>=3.28" \
-      "tzdata>=2019" \
-      "mariadb-dev>=10.3" \
-    && rm -rf /var/cache/apk/*
-
-RUN apk add --no-cache openssl less
-
-ENV DOCKERIZE_VERSION v0.6.1
-RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
-    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
-    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
-
-
-WORKDIR /home
-
-COPY Gemfile /home/Gemfile
-COPY pact_broker.gemspec /home/pact_broker.gemspec
-COPY lib/pact_broker/version.rb /home/lib/pact_broker/version.rb
-COPY .gitignore /home/.gitignore
-
-RUN gem install bundler -v '~>2.0.0' \
-    && bundle install --jobs 3 --retry 3
-
-COPY lib /home/lib
-COPY db /home/db
-COPY public /home/public
-COPY tasks /home/tasks
-COPY config.ru /home/config.ru
-COPY Rakefile /home/Rakefile
-COPY script  /home/script
-
-RUN ls /home

data/optic.yml

@@ -1,5 +0,0 @@
-name: "Pact Broker"
-tasks:
-  start:
-     command: "bundle exec rackup -p ${PORT}"
-     inboundUrl: http://localhost:4000

data/pact_broker_client-pact_broker.json

@@ -1,133 +0,0 @@
-{
-  "provider": {
-    "name": "Pact Broker"
-  },
-  "consumer": {
-    "name": "Pact Broker Client"
-  },
-  "interactions": [
-  {
-    "description": "a request to publish a pact",
-    "request": {
-      "method": "put",
-      "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
-      "body": {
-        "consumer": {
-          "name": "Condor"
-        },
-        "provider": {
-          "name": "Pricing Service"
-        },
-        "interactions": [
-
-        ]
-      },
-      "headers": {
-        "X-Pact-Broker-Client-Version": "2.0.0",
-        "Content-Type": "application/json"
-      }
-    },
-    "response": {
-      "headers": {
-      },
-      "status": 201
-    }
-  },
-  {
-    "description": "a request to publish a pact",
-    "providerState": "an error occurs while publishing a pact",
-    "request": {
-      "method": "put",
-      "path": "/pacticipant/Condor/versions/1.3.0/pacts/Pricing%20Service",
-      "body": {
-        "consumer": {
-          "name": "Condor"
-        },
-        "provider": {
-          "name": "Pricing Service"
-        },
-        "interactions": [
-
-        ]
-      },
-      "headers": {
-        "X-Pact-Broker-Client-Version": "2.0.0",
-        "Content-Type": "application/json"
-      }
-    },
-    "response": {
-      "status": 500,
-      "headers": {
-      },
-      "body": {
-        "error": {
-          "json_class": "Pact::Term",
-          "data": {
-            "generate": "An error occurred",
-            "matcher": {"json_class":"Regexp","o":0,"s":".*"}
-          }
-        }
-      }
-    }
-  },
-  {
-    "description": "a request to retrieve the repository URL of the 'Pricing Service'",
-    "providerState": "the 'Pricing Service' does not exist in the pact-broker",
-    "request": {
-      "method": "get",
-      "path": "/pacticipant/Pricing%20Service/repository_url",
-      "headers": {
-        "X-Pact-Broker-Client-Version": "2.0.0",
-        "Accept": "text/plain"
-      }
-    },
-    "response": {
-      "status": 404,
-      "headers": {
-      }
-    }
-  },
-
-    {
-      "description": "a request to register the repository URL of a pacticipant",
-      "providerState": "the 'Pricing Service' does not exist in the pact-broker",
-      "request": {
-        "method": "patch",
-        "path": "/pacticipant/Pricing%20Service",
-        "body": {
-          "repository_url": "git@git.realestate.com.au:business-systems/condor.git"
-        },
-        "headers": {
-          "X-Pact-Broker-Client-Version": "2.0.0",
-          "Content-Type": "application/json+patch"
-        }
-      },
-      "response": {
-        "status": 201
-      }
-    },
-  {
-    "description": "a request to retrieve the repository URL of the 'Pricing Service'",
-    "providerState": "the 'Pricing Service' already exists in the pact-broker",
-    "request": {
-      "method": "get",
-      "path": "/pacticipant/Pricing%20Service/repository_url",
-      "headers": {
-        "X-Pact-Broker-Client-Version": "2.0.0",
-        "Accept": "text/plain"
-      }
-    },
-    "response": {
-      "status": 200,
-      "headers": {"Content-Type": "text/plain;charset=utf-8"
-      },
-      "body": "git@git.realestate.com.au:business-systems/condor.git"
-    }
-  }
-  ],
-  "metadata": {
-    "pact_gem": {
-      "version": "1.0.15"
-    }
-  }
-}