pact_broker 2.77.0 → 2.78.0

data/lib/pact_broker/configuration.rb

@@ -31,6 +31,7 @@ module PactBroker
       :webhook_http_method_whitelist,
       :webhook_scheme_whitelist,
       :webhook_host_whitelist,
+      :webhook_http_code_success,
       :base_equality_only_on_content_that_affects_verification_results,
       :seed_example_data,
       :badge_provider_mode,

data/lib/pact_broker/deployments/environment.rb

@@ -0,0 +1,15 @@
+require 'sequel'
+require 'sequel/plugins/serialization'
+
+
+module PactBroker
+  module Deployments
+    class Environment < Sequel::Model
+      OPEN_STRUCT_TO_JSON = lambda { |thing| Sequel.object_to_json(thing.collect(&:to_h)) }
+      JSON_TO_OPEN_STRUCT = lambda { | json | Sequel.parse_json(json).collect{ | hash| OpenStruct.new(hash) } }
+      plugin :upsert, identifying_columns: [:uuid]
+      plugin :serialization
+      serialize_attributes [OPEN_STRUCT_TO_JSON, JSON_TO_OPEN_STRUCT], :contacts
+    end
+  end
+end

data/lib/pact_broker/deployments/environment_service.rb

@@ -0,0 +1,39 @@
+require 'pact_broker/deployments/environment'
+require 'securerandom'
+
+module PactBroker
+  module Deployments
+    module EnvironmentService
+
+      def self.next_uuid
+        SecureRandom.uuid
+      end
+
+      def self.create(uuid, environment)
+        environment.uuid = uuid
+        environment.save
+      end
+
+      def self.update(uuid, environment)
+        environment.uuid = uuid
+        environment.upsert
+      end
+
+      def self.find_all
+        PactBroker::Deployments::Environment.order(Sequel.function(:lower, :display_name)).all
+      end
+
+      def self.find(uuid)
+        PactBroker::Deployments::Environment.where(uuid: uuid).single_record
+      end
+
+      def self.find_by_name(name)
+        PactBroker::Deployments::Environment.where(name: name).single_record
+      end
+
+      def self.delete(uuid)
+        PactBroker::Deployments::Environment.where(uuid: uuid).delete
+      end
+    end
+  end
+end

data/lib/pact_broker/doc/views/index/environment.markdown

@@ -0,0 +1,37 @@
+# Environment
+
+Allowed methods: `GET`, `PUT`, `DELETE`
+
+Path: `/environment/{uuid}`
+
+## Viewing an environment
+
+Example:
+
+    curl http://${PACT_BROKER_HOST}/environments/79060381-269c-4769-9894-9ec3cab44729 \
+      -H "Accept: application/hal+json"
+    {
+      "uuid": "79060381-269c-4769-9894-9ec3cab44729",
+      "name": "test",
+      "displayName": "Test",
+      "production": false
+    }
+
+## Updating an environment
+
+Example:
+
+    curl -X PUT http://${PACT_BROKER_HOST}/environments/79060381-269c-4769-9894-9ec3cab44729 \
+      -H "Content-Type: application/json" \
+      -H "Accept: application/hal+json" \
+      -d '{
+          "name": "test",
+          "displayName": "Test",
+          "production": false
+        }'
+
+## Deleting an environment
+
+Example:
+
+    curl -v -X DELETE http://${PACT_BROKER_HOST}/environments/79060381-269c-4769-9894-9ec3cab44729

data/lib/pact_broker/doc/views/index/environments.markdown

@@ -0,0 +1,53 @@
+# Environments
+
+Allowed methods: `GET`, `POST`
+
+Path: `/environments`
+
+## Creating an environment
+
+Send a POST to `/environments` with the environment payload.
+
+Example:
+
+    curl http://${PACT_BROKER_HOST}/environments \
+      -H "Content-Type: application/json" \
+      -H "Accept: application/hal+json" \
+      -d '{
+          "name": "test",
+          "displayName": "Test",
+          "production": false
+        }'
+
+Alternatively, you can use the HAL Browser.
+
+* Click on the `API Browser` link at the top of the Pact Broker index page.
+* In the `Links` section on the left, locate the `pb:environments` relation, and click on the yellow `!` "Perform non-GET request" button.
+* In the `Body:` text box, fill in the required JSON properties.
+* Click `Make Request`.
+
+Properties:
+
+* `uuid`: System generated unique identifier.
+* `name`: Must be unique. No spaces allowed. This will be the name used in the `can-i-deploy` and `record-deployment` CLI commands. eg. "payments-sit-1"
+* `displayName`: A more verbose name for the environment. "Payments Team SIT 1"
+* `production`: Whether or not this environment is a production environment.
+
+If all the services in the Broker are deployed to the same "public" internet, then there only needs to be one Production environment. If there are multiple segregated production environments (eg. when maintaining on-premises software for multiple customers ) then you should create a separate production Environment for each logical deployment environment.
+
+## Listing environments
+
+`GET /environments`
+
+    {
+      "_embedded": {
+        "environments": [
+          {
+            "uuid": "79060381-269c-4769-9894-9ec3cab44729",
+            "name": "production",
+            "displayName": "Production",
+            "production": true
+          }
+        ]
+      }
+    }

data/lib/pact_broker/doc/views/index/latest-pact-versions.markdown

@@ -1,5 +1,5 @@
 # Latest pact versions
 
-Allowed methods: GET
+Allowed methods: `GET`
 
 A list of the latest pact versions for each consumer/provider pair. The "latest" is determined by inspecting the consumer version used when each pact was published.

data/lib/pact_broker/doc/views/index/pacticipant-version-tag.markdown

@@ -1,6 +1,7 @@
 # Pacticipant version tag
 
 Allowed methods: `GET`, `PUT`, `DELETE`
+
 Path: `/pacticipants/{pacticipant}/versions/{version}/tags/{tag}`
 
 To create a tag, send an empty request with the URL specified above and `Content-Type` of `application/json`.

data/lib/pact_broker/locale/en.yml

@@ -9,7 +9,8 @@ en:
     valid_consumer_version_number?: "Consumer version number '%{value}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
     non_templated_host?: "cannot have a template parameter in the host"
     pacticipant_exists?: "does not match an existing pacticipant"
-
+    single_line?: "cannot contain multiple lines"
+    no_spaces?: "cannot contain spaces"
 
   pact_broker:
     messages:
@@ -46,6 +47,7 @@ en:
         connection_encoding_not_utf8: "The Sequel connection encoding (%{encoding}) is strongly recommended to be \"utf8\". If you need to set it to %{encoding} for some particular reason, then disable this check by setting config.validate_database_connection_config = false"
         invalid_webhook_uuid: The UUID can only contain the characters A-Z, a-z, 0-9, _ and -, and must be 16 or more characters.
         pacticipant_not_found: No pacticipant with name '%{name}' found
+        environment_name_must_be_unique: Another environment with name '%{name}' already exists.
       duplicate_pacticipant: |
         This is the first time a pact has been published for "%{new_name}".
         The name "%{new_name}" is very similar to the following existing consumers/providers:

data/lib/pact_broker/services.rb

@@ -73,6 +73,10 @@ module PactBroker
       get(:metrics_service)
     end
 
+    def environment_service
+      get(:environment_service)
+    end
+
     def register_default_services
       register_service(:index_service) do
         require 'pact_broker/index/service'
@@ -148,6 +152,11 @@ module PactBroker
         require 'pact_broker/webhooks/trigger_service'
         Webhooks::TriggerService
       end
+
+      register_service(:environment_service) do
+        require 'pact_broker/deployments/environment_service'
+        Deployments::EnvironmentService
+      end
     end
   end
 end

data/lib/pact_broker/test/test_data_builder.rb

@@ -24,6 +24,7 @@ require 'pact_broker/tags/repository'
 require 'pact_broker/webhooks/repository'
 require 'pact_broker/certificates/certificate'
 require 'pact_broker/matrix/row'
+require 'pact_broker/deployments/environment_service'
 require 'ostruct'
 
 module PactBroker
@@ -45,6 +46,7 @@ module PactBroker
       attr_reader :webhook
       attr_reader :webhook_execution
       attr_reader :triggered_webhook
+      attr_reader :environment
 
       def initialize(params = {})
         @now = DateTime.now
@@ -381,6 +383,18 @@ module PactBroker
         self
       end
 
+      def create_environment(name, params = {})
+        uuid = params[:uuid] || PactBroker::Deployments::EnvironmentService.next_uuid
+        production = params[:production] || false
+        @environment = PactBroker::Deployments::EnvironmentService.create(uuid, PactBroker::Deployments::Environment.new(params.merge(name: name, production: production)))
+        set_created_at_if_set(params[:created_at], :environments, id: environment.id)
+        self
+      end
+
+      def create_deployment(_)
+        self
+      end
+
       def create_everything_for_an_integration
         create_pact_with_verification("Foo", "1", "Bar", "2")
           .create_label("label")

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.77.0'
+  VERSION = '2.78.0'
 end

data/lib/pact_broker/versions/repository.rb

@@ -9,6 +9,7 @@ module PactBroker
 
       include PactBroker::Logging
       include PactBroker::Repositories::Helpers
+      include PactBroker::Repositories
 
       def find_by_pacticipant_id_and_number pacticipant_id, number
         PactBroker::Domain::Version.where(number: number, pacticipant_id: pacticipant_id).single_record
@@ -60,13 +61,23 @@ module PactBroker
         PactBroker::Domain::Version.new(version_params).upsert
       end
 
-      def create_or_update(pacticipant, version_number, version)
-        PactBroker::Domain::Version.new(
+      def create_or_overwrite(pacticipant, version_number, open_struct_version)
+        saved_version = PactBroker::Domain::Version.new(
           number: version_number,
           pacticipant: pacticipant,
-          build_url: version.build_url,
-          branch: version.branch
+          build_url: open_struct_version.build_url,
+          branch: open_struct_version.branch
         ).upsert
+
+        if open_struct_version.tags
+          tag_repository.delete_by_version_id(saved_version.id)
+          open_struct_version.tags.collect do | open_struct_tag |
+            tag_repository.create(version: saved_version, name: open_struct_tag.name)
+          end
+          saved_version.refresh
+        end
+
+        saved_version
       end
 
       def find_by_pacticipant_id_and_number_or_create pacticipant_id, number

data/lib/pact_broker/versions/service.rb

@@ -18,9 +18,9 @@ module PactBroker
         version_repository.find_by_pacticipant_name_and_latest_tag(pacticipant_name, tag)
       end
 
-      def self.create_or_update(pacticipant_name, version_number, version)
+      def self.create_or_overwrite(pacticipant_name, version_number, version)
         pacticipant = pacticipant_repository.find_by_name_or_create(pacticipant_name)
-        version_repository.create_or_update(pacticipant, version_number, version)
+        version_repository.create_or_overwrite(pacticipant, version_number, version)
       end
 
       def self.delete version

data/lib/pact_broker/webhooks/webhook_execution_result.rb

@@ -14,7 +14,10 @@ module PactBroker
       end
 
       def success?
-        !response.nil? && response.code.to_i < 300
+        unless response.nil?
+          # Response HTTP Code must be in success list otherwise it is false
+          PactBroker.configuration.webhook_http_code_success.include? response.code.to_i
+        end
       end
     end
   end

data/spec/features/create_environment_spec.rb

@@ -0,0 +1,47 @@
+require 'pact_broker/api/pact_broker_urls'
+
+describe "Creating an environment" do
+  let(:path) { PactBroker::Api::PactBrokerUrls.environments_url }
+  let(:headers) { { "CONTENT_TYPE" => "application/json" } }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+  let(:environment_hash) do
+    {
+      name: "test",
+      displayName: "Test",
+      production: false,
+      contacts: [
+        { name: "Team Awesome", details: { email: "foo@bar.com", arbitraryThing: "thing" } }
+      ]
+    }
+  end
+
+  subject { post(path, environment_hash.to_json, headers) }
+
+  it "returns a 201 response" do
+    expect(subject.status).to be 201
+  end
+
+  it "returns the Location header" do
+    expect(subject.headers["Location"]).to eq PactBroker::Api::PactBrokerUrls.environment_url(PactBroker::Deployments::Environment.order(:id).last, "http://example.org")
+  end
+
+  it "returns a JSON Content Type" do
+    expect(subject.headers["Content-Type"]).to eq "application/hal+json;charset=utf-8"
+  end
+
+  it "returns the newly created environment" do
+    expect(response_body).to include environment_hash.merge(name: "test")
+    expect(response_body[:uuid]).to_not be nil
+  end
+
+  context "with invalid params" do
+    before do
+      td.create_environment("test")
+    end
+
+    it "returns a 400 response" do
+      expect(subject.status).to be 400
+      expect(response_body[:errors]).to_not be nil
+    end
+  end
+end

data/spec/features/create_tag_spec.rb

@@ -0,0 +1,32 @@
+describe "Creating a tag" do
+  let(:path) { "/pacticipants/Foo/versions/1234/tags/foo" }
+  let(:headers) { { 'CONTENT_TYPE' => 'application/json' } }
+  let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
+
+  subject { put(path, {}, headers) }
+
+  it "returns a 201 response" do
+    expect(subject.status).to be 201
+  end
+
+  it "returns a HAL JSON Content Type" do
+    expect(subject.headers['Content-Type']).to eq 'application/hal+json;charset=utf-8'
+  end
+
+  it "returns the newly created tag" do
+    expect(response_body).to include name: "foo"
+  end
+
+  context "when the tag already exists" do
+    before do
+      td.subtract_day
+        .create_consumer("Foo")
+        .create_consumer_version("1234")
+        .create_consumer_version_tag("foo")
+    end
+
+    it "returns a 200 response" do
+      expect(subject.status).to be 200
+    end
+  end
+end

data/spec/features/create_version_spec.rb

@@ -2,7 +2,13 @@ describe "Creating a pacticipant version" do
   let(:path) { "/pacticipants/Foo/versions/1234" }
   let(:headers) { { 'CONTENT_TYPE' => 'application/json' } }
   let(:response_body) { JSON.parse(subject.body, symbolize_names: true)}
-  let(:version_hash) { { branch: "main", buildUrl: "http://build" } }
+  let(:version_hash) do
+    {
+      branch: "main",
+      buildUrl: "http://build",
+      tags: [{ name: "foo" }, { name: "bar" }]
+    }
+  end
 
   subject { put(path, version_hash.to_json, headers) }
 
@@ -15,7 +21,12 @@ describe "Creating a pacticipant version" do
   end
 
   it "returns the newly created version" do
-    expect(response_body).to include version_hash
+    expect(response_body).to include branch: "main", buildUrl: "http://build"
+    expect(response_body[:_embedded][:tags].size).to eq 2
+  end
+
+  it "creates the specified tags" do
+    expect { subject }.to change { PactBroker::Domain::Tag.count }.by(2)
   end
 
   context "when the version already exists" do
@@ -28,13 +39,28 @@ describe "Creating a pacticipant version" do
 
     let(:version_hash) { { branch: "new-branch" } }
 
+    it "returns a 200" do
+      expect(subject.status).to be 200
+    end
+
     it "overwrites the direct properties" do
       expect(response_body[:branch]).to eq "new-branch"
       expect(response_body).to_not have_key(:buildUrl)
     end
 
-    it "does not change the tags" do
-      expect { subject }.to_not change { PactBroker::Domain::Version.for("Foo", "1234").tags }
+    context "when not tags are specified" do
+      it "does not change the tags" do
+        expect { subject }.to_not change { PactBroker::Domain::Version.for("Foo", "1234").tags }
+      end
+    end
+
+    context "when tags are specified" do
+      let(:version_hash) { { branch: "new-branch", tags: [ { name: "main" }] } }
+
+      it "overwrites the tags" do
+        expect(response_body[:_embedded][:tags].size).to eq 1
+        expect(response_body[:_embedded][:tags].first[:name]).to eq "main"
+      end
     end
 
     it "does not change the created date" do