pact_broker 2.84.0 → 2.87.0

data/lib/pact_broker/ui/view_models/index_item.rb

@@ -3,6 +3,8 @@ require "pact_broker/ui/helpers/url_helper"
 require "pact_broker/date_helper"
 require "pact_broker/versions/abbreviate_number"
 require "pact_broker/configuration"
+require "pact_broker/ui/view_models/index_item_branch_head"
+require "pact_broker/ui/view_models/index_item_provider_branch_head"
 require "forwardable"
 
 module PactBroker
@@ -18,7 +20,8 @@ module PactBroker
           :provider_version_branches,
           :latest_for_branch?,
           :consumer_version_environment_names,
-          :provider_version_environment_names
+          :provider_version_environment_names,
+          :latest_verification
         ] => :relationship
 
 
@@ -57,10 +60,20 @@ module PactBroker
           PactBroker::Versions::AbbreviateNumber.call(provider_version_number)
         end
 
+        def display_latest_label?
+          consumer_version_latest_tag_names.empty? && @relationship.tag_names.empty?
+        end
+
         def latest?
           @relationship.latest?
         end
 
+        def consumer_version_branch_heads
+          @relationship.consumer_version_branch_heads.collect do | branch_head |
+            IndexItemBranchHead.new(branch_head, consumer_name)
+          end
+        end
+
         def consumer_version_latest_tag_names
           @relationship.tag_names
         end
@@ -69,6 +82,12 @@ module PactBroker
           @relationship.latest_verification_latest_tags.collect(&:name)
         end
 
+        def provider_version_branch_heads
+          @relationship.provider_version_branch_heads.collect do | branch_head |
+            IndexItemProviderBranchHead.new(branch_head, provider_name)
+          end
+        end
+
         def consumer_group_url
           Helpers::URLHelper.group_url(consumer_name, base_url)
         end
@@ -81,12 +100,16 @@ module PactBroker
           "#{pactigration_base_url(base_url, @relationship)}/latest"
         end
 
+        def dashboard_url
+          Helpers::URLHelper.dashboard_url(consumer_name, provider_name, base_url)
+        end
+
         def pact_url
           PactBroker::Api::PactBrokerUrls.pact_url(base_url, @relationship)
         end
 
         def pact_matrix_url
-          Helpers::URLHelper.matrix_url(consumer_name, provider_name, base_url)
+          Helpers::URLHelper.matrix_url_for_consumer_version(consumer_name, consumer_version_number, provider_name, base_url)
         end
 
         def any_webhooks?
@@ -145,7 +168,7 @@ module PactBroker
 
         def last_verified_date
           if @relationship.ever_verified?
-            date = @relationship.latest_verification.execution_date
+            date = latest_verification.execution_date
             PactBroker::DateHelper.distance_of_time_in_words(date, DateTime.now) + " ago"
           else
             ""
@@ -166,10 +189,15 @@ module PactBroker
             when :success then "success"
             when :stale then "warning"
             when :failed then "danger"
+            when :failed_pending then "danger"
             else ""
           end
         end
 
+        def failed_and_pact_pending?
+          latest_verification&.failed_and_pact_pending?
+        end
+
         def warning?
           pseudo_branch_verification_status == "warning"
         end
@@ -179,7 +207,18 @@ module PactBroker
           when :success
             "Successfully verified by #{provider_name} (#{short_version_number(@relationship.latest_verification_provider_version_number)})"
           when :stale
-            "Pact has changed since last successful verification by #{provider_name} (#{short_version_number(@relationship.latest_verification_provider_version_number)})"
+            # TODO when there are multiple tags/branches, the tag/branch shown may not be the relevant one, but
+            # it shouldn't happen very often. Can change this to "tag a or b"
+            desc =  if @relationship.consumer_version_branches.any?
+                      "from branch #{@relationship.consumer_version_branches.first} "
+                    elsif @relationship.tag_names.any?
+                      "with tag #{@relationship.tag_names.first} "
+                    else
+                      ""
+                    end
+            "Pact #{desc}has changed since last successful verification by #{provider_name} (#{short_version_number(@relationship.latest_verification_provider_version_number)})"
+          when :failed_pending
+            "Verification by #{provider_name} (#{short_version_number(@relationship.latest_verification_provider_version_number)}) failed, but did not fail the build as the pact content was in pending state for that provider branch"
           when :failed
             "Verification by #{provider_name} (#{short_version_number(@relationship.latest_verification_provider_version_number)}) failed"
           else
@@ -204,17 +243,34 @@ module PactBroker
           end
         end
 
+        def show_menu?
+          !view_by_environment? && (@relationship.tag_names.any? || consumer_version_branches.any?)
+        end
+
         def base_url
           @options[:base_url]
         end
 
-        def tagged_pacts
+        def pact_tags
           @relationship.tag_names.map do |tag|
             {
-              tag: tag,
+              name: tag,
               deletionUrl: PactBroker::Api::PactBrokerUrls.tagged_pact_versions_url(consumer_name, provider_name, tag, base_url)
-            }.to_json
-          end
+            }
+          end.to_json
+        end
+
+        def pact_branches
+          consumer_version_branches.map do | branch_name |
+            {
+              name: branch_name,
+              deletionUrl: PactBroker::Api::PactBrokerUrls.pact_versions_for_branch_url(consumer_name, provider_name, branch_name, base_url)
+            }
+          end.to_json
+        end
+
+        def view_by_environment?
+          @options[:view] == "environment"
         end
 
         private

data/lib/pact_broker/ui/view_models/index_item_branch_head.rb

@@ -0,0 +1,39 @@
+require "pact_broker/api/pact_broker_urls"
+require "pact_broker/ui/helpers/url_helper"
+require "pact_broker/date_helper"
+
+module PactBroker
+  module UI
+    module ViewDomain
+      class IndexItemBranchHead
+
+        include PactBroker::Api::PactBrokerUrls
+
+        def initialize branch_head, pacticipant_name
+          @branch_head = branch_head
+          @pacticipant_name = pacticipant_name
+        end
+
+        def branch_name
+          branch_head.branch_name
+        end
+
+        def tooltip
+          if branch_head.branch_version.auto_created
+            "This is the latest pact from branch \"#{branch_name}\". This branch was automatically inferred from the first tag because the Pact Broker configuration setting `use_first_tag_as_branch` was true."
+          else
+            "This is the latest pact from branch \"#{branch_name}\"."
+          end
+        end
+
+        def latest?
+          true
+        end
+
+        private
+
+        attr_reader :branch_head, :pacticipant_name
+      end
+    end
+  end
+end

data/lib/pact_broker/ui/view_models/index_item_provider_branch_head.rb

@@ -0,0 +1,39 @@
+require "pact_broker/api/pact_broker_urls"
+require "pact_broker/ui/helpers/url_helper"
+require "pact_broker/date_helper"
+
+module PactBroker
+  module UI
+    module ViewDomain
+      class IndexItemProviderBranchHead
+
+        include PactBroker::Api::PactBrokerUrls
+
+        def initialize branch_head, pacticipant_name
+          @branch_head = branch_head
+          @pacticipant_name = pacticipant_name
+        end
+
+        def branch_name
+          branch_head.branch_name
+        end
+
+        def tooltip
+          if branch_head.branch_version.auto_created
+            "The latest verification is from branch \"#{branch_name}\". This branch was automatically inferred from the first tag because the Pact Broker configuration setting `use_first_tag_as_branch` was true."
+          else
+            "The latest verification is from branch \"#{branch_name}\"."
+          end
+        end
+
+        def latest?
+          true
+        end
+
+        private
+
+        attr_reader :branch_head, :pacticipant_name
+      end
+    end
+  end
+end

data/lib/pact_broker/ui/view_models/matrix_branch.rb

@@ -22,7 +22,7 @@ module PactBroker
           if branch_version.latest?
             "This is the latest version of #{pacticipant_name} from branch \"#{branch_version.branch_name}\"."
           else
-            "A more recent version of #{pacticipant_name} from branch \"#{branch_version.branch_name}\" exists."
+            "This version of #{pacticipant_name} is from branch \"#{branch_version.branch_name}\". A more recent version from this branch exists."
           end
         end
 

data/lib/pact_broker/ui/view_models/matrix_tag.rb

@@ -6,7 +6,6 @@ module PactBroker
   module UI
     module ViewDomain
       class MatrixTag
-
         include PactBroker::Api::PactBrokerUrls
 
         attr_reader :name, :pacticipant_name, :version_number

data/lib/pact_broker/ui/views/dashboard/show.haml

@@ -0,0 +1,202 @@
+%body
+  != render :haml, :'index/_css_and_js', :layout => false
+  .container
+    != render :haml, :'index/_dashboard_navbar', :layout => false, locals: {tag_toggle: nil, base_url: base_url}
+
+    %div.mt-4
+      .row
+        .col
+          .row.my-0
+            .col.my-0{ style: "text-transform: uppercase; font-size: 70%"}
+              Consumer
+          .row.my-0
+            .col.my-0
+              %h2.page-header{ style: "margin-top: 0" }
+                = consumer_name
+        .col
+          .row
+            .col.my-0{ style: "text-transform: uppercase; font-size: 70%"}
+              Provider
+          .row.my-0
+            .col.my-0
+              %h2.page-header{ style: "margin-top: 0" }
+                = provider_name
+
+
+    - unless errors.blank?
+      - errors.each do | error |
+        %div.alert.alert-danger
+          = error
+
+    - if consumer && provider
+      %form
+        %div.mt-4.mb-2
+          %label.mr-2
+            View pacts by:
+          %div.form-check.form-check-inline
+            %input.form-check-input{ type: "radio", name: "view", id: "by_branch", value: "branch", checked: view == "branch" }
+            %label.form-check-label{ for:"by_branch"} branches
+          %div.form-check.form-check-inline
+            %input.form-check-input{ type: "radio", name: "view", id: "by_tag", value: "tag", checked: view == "tag"}
+            %label.form-check-label{ for:"by_tag"} tags
+          %div.form-check.form-check-inline
+            %input.form-check-input{ type: "radio", name: "view", id: "by_environment", value: "environment", checked: view == "environment"}
+            %label.form-check-label{ for:"by_environment"} environments
+          %div.form-check.form-check-inline
+            %input.form-check-input{ type: "radio", name: "view", id: "by_all", value: "all", checked: view == "all"}
+            %label.form-check-label{ for:"by_all"} no filter
+        %input{ type: "hidden", name: "page", value: page_number }
+        %input{ type: "hidden", name: "pageSize", value: page_size }
+
+      %table.table.table-bordered.table-striped{ id: 'relationships' }
+        %thead
+          %tr
+            %th.consumer-version-number
+              Consumer<br>Version
+              %span.sort-icon.relationships-sort
+            %th.provider-version-number
+              Provider<br>Version
+              %span.sort-icon.relationships-sort
+            %th.pact{ style: 'width: 40px' }
+            %th
+              Published
+              %span.sort-icon.relationships-sort
+            %th
+              Webhook<br>status
+            %th
+              Last<br>verified
+              %span.sort-icon.relationships-sort
+            %th
+        %tbody
+
+          - index_items.each do | index_item |
+            %tr{'data-pact-versions-url': index_item.pact_versions_url,
+                'data-consumer-name': index_item.consumer_name,
+                'data-provider-name': index_item.provider_name,
+                'data-integration-url': index_item.integration_url,
+                'data-pact-tags': index_item.pact_tags,
+                'data-pact-branches': index_item.pact_branches,
+                'data-view': view
+                }
+              %td.consumer-version-number{"data-text": index_item.consumer_version_order}
+                %div.clippable{"data-clippable": index_item.consumer_version_number}
+                  = index_item.display_consumer_version_number
+                  - if index_item.display_consumer_version_number
+                    %button.clippy.invisible{ title: "Copy to clipboard" }
+                      %span.copy-icon
+                - if view == "branch" || view == "all"
+                  - index_item.consumer_version_branch_heads.each do | branch_head |
+                    %div{"class": "tag badge badge-dark", "title": branch_head.tooltip, "data-toggle": "tooltip", "data-placement": "right"}
+                      = "branch: " + branch_head.branch_name
+                - if view == "tag" || view == "all"
+                  - index_item.consumer_version_latest_tag_names.each do | tag_name |
+                    .tag.badge.badge-primary
+                      = "tag: " + tag_name
+                - if view == "environment" || view == "all"
+                  - index_item.consumer_version_environment_names.each do | environment_name |
+                    .tag.badge.badge-success
+                      = "env: " + environment_name
+                - if view == "all" && index_item.display_latest_label? && index_item.latest?
+                  .tag.badge.bg-light
+                    latest
+              %td.provider-version-number
+                %div.clippable{"data-clippable": index_item.provider_version_number}
+                  = index_item.display_provider_version_number
+                  - if index_item.display_provider_version_number
+                    %button.clippy.invisible{ title: "Copy to clipboard" }
+                      %span.copy-icon
+                - if view == "branch" || view == "all"
+                  - index_item.provider_version_branch_heads.each do | branch_head |
+                    %div{"class": "tag badge badge-dark", "title": branch_head.tooltip, "data-toggle": "tooltip", "data-placement": "right"}
+                      = "branch: " + branch_head.branch_name
+                - if view == "tag" || view == "all"
+                  - index_item.provider_version_latest_tag_names.each do | tag_name |
+                    .tag.badge.badge-primary
+                      = "tag: " + tag_name
+                - if view == "environment" || view == "all"
+                  - index_item.provider_version_environment_names.each do | environment_name |
+                    .tag.badge.badge-success
+                      = "env: " + environment_name
+              %td.pact
+                %span.pact
+                  %a{ href: index_item.pact_url, title: "View pact" }
+                %span.pact-matrix
+                  %a{ href: index_item.pact_matrix_url, title: "View pact matrix" }
+              %td{"data-text": index_item.publication_date_of_latest_pact_order}
+                = index_item.publication_date_of_latest_pact.gsub("about ", "")
+              %td{ class: "table-#{index_item.webhook_status}" }
+                - if index_item.show_webhook_status?
+                  %a{ href: index_item.webhook_url }
+                    = index_item.webhook_label
+
+              %td{ class: "table-#{index_item.pseudo_branch_verification_status}", title: index_item.verification_tooltip, "data-toggle": "tooltip", "data-placement": "left" }
+                %div
+                  = index_item.last_verified_date.gsub("about ", "")
+                  - if index_item.warning?
+                    %span.warning-icon{ 'aria-hidden': true }
+                - if index_item.failed_and_pact_pending?
+                  %div
+                    (pact pending)
+              %td
+                - if index_item.show_menu?
+                  %span.integration-settings.kebab-horizontal{ 'aria-hidden': true }
+
+      %div.pagination.text-center
+
+      - pagination_locals = { page_number: page_number, page_size: page_size, pagination_record_count: pagination_record_count, current_page_size: current_page_size }
+      != render :haml, :'index/_pagination', :layout => false, locals: pagination_locals
+
+  :javascript
+    $(function(){
+      $("#relationships").tablesorter();
+    });
+
+    $(document).ready(function(){
+      initializeClipper(".clippable");
+
+      $("span.pact a").load("#{base_url}/images/doc-text.svg");
+      $("span.pact-matrix a").load("#{base_url}/images/doc-matrix.svg");
+      $('td[data-toggle="tooltip"]').each(function(index, td){
+        //appended tooltip div screws up table if it's appended after a
+        //td, so need to append it to a div
+        $(td).tooltip({ container: $(td).first() });
+      });
+
+      // https://www.w3schools.com/bootstrap/bootstrap_ref_js_tooltip.asp
+
+      $('div[data-toggle="tooltip"]').each(function(index, div){
+        $(div).tooltip()
+      });
+
+    });
+
+    $(".reset-search").on("click", function() {
+      const url = new URL(window.location)
+      url.searchParams.delete('search')
+      window.location = url.toString();
+    })
+
+    $(".submit-search").on("click", function() {
+      search = $("#search").val();
+      const url = new URL(window.location)
+      url.searchParams.set('search', search)
+      window.location = url.toString();
+    })
+
+    $(".search").keypress(function(event) {
+      const enterKeyCode = 13;
+
+      const key = event.which;
+      if (key === enterKeyCode) {
+        event.preventDefault();
+        search = $("#search").val();
+        const url = new URL(window.location)
+        url.searchParams.set('search', search)
+        window.location = url.toString();
+      }
+    })
+
+    $("[name*='view']").change(function(event){
+      $("[name='page']").attr('disabled','disabled');
+      $(this.form).submit()
+    })

data/lib/pact_broker/ui/views/groups/show.html.erb

@@ -1,17 +1,25 @@
 <% require 'sanitize' %>
+<% require 'pact_broker/version' %>
+<% version = PactBroker::VERSION %>
 
 <!DOCTYPE html>
 <html lang="en">
 <head>
 <meta charset="utf-8">
-<title>Network Graph</title>
+<title><%= pacticipant_name %></title>
 <link rel='shortcut icon' href='<%= base_url %>/favicon.ico' type='image/x-icon'/>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="description" content="">
 <meta name="author" content="Duncan Alexander">
 <script type="text/javascript" src="<%= base_url %>/javascripts/d3.v3.js.pagespeed.ce.dFNRrGTALe.js"></script>
+<link href="<%= base_url %>/css/bootstrap.min.css?v=<%= version %>" rel="stylesheet">
+<script src="<%= base_url %>/javascripts/jquery-3.5.1.min.js?v=<%= version %>" type='text/javascript'></script>
+<script src="<%= base_url %>/js/bootstrap.bundle.min.js?v=<%= version %>" type='text/javascript'></script>
 <style>
-body{
+body {
+  padding-top: 10px;
+}
+svg{
     font-family:"Helvetica Neue",Arial,sans-serif;
     font-size:.95em;
     font-weight:bold;
@@ -23,6 +31,11 @@ body{
  .relationship {
     cursor: pointer;
  }
+ .page-header {
+   padding-bottom: 9px;
+   margin: 40px 0 20px;
+   border-bottom: 1px solid #eee;
+ }
 </style>
 <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
 <!--[if lt IE 9]>
@@ -31,20 +44,52 @@ body{
 <!-- developed by Duncan Alexander - hypothete.com -->
 </head>
 <body>
-<h1>Network graph of <%= escape_html(pacticipant_name) %> relationships</h1>
-
-<% if repository_url %>
-<p>Repository URL:
-
-<%
-repository_link = "<a href=\"#{repository_url}\">#{repository_url}</a>"
-%>
-
-<%= Sanitize.fragment(repository_link, Sanitize::Config::BASIC) %>
-
+<div class="container">
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <li class="breadcrumb-item" style="margin:0;"><a href="<%= base_url %>/">Home</a></li>
+    <li class="breadcrumb-item active" aria-current="page"><%= escape_html(pacticipant_name) %></li>
+  </ol>
+</nav>
+<h1 class="page-header"><%= escape_html(pacticipant_name) %></h1>
+
+<ul class="nav nav-tabs">
+  <li class="nav-item">
+    <a class="nav-link <%= tab == "details" ? "active" : "" %>" href="<%= details_url %>">Details</a>
+  </li>
+  <li class="nav-item">
+    <a class="nav-link <%= tab == "network" ? "active" : "" %>" href="<%= network_url %>">Network Graph</a>
+  </li>
+</ul>
+
+<% if tab == "details" %>
+  <div class="container mt-5">
+    <div class="row">
+      <div class="col col-md-2">
+        Main branch:
+      </div>
+      <div class="col col-md-6">
+        <%= pacticipant.main_branch %>
+      </div>
+    </div>
+    <div class="row">
+      <div class="col col-md-2">
+        Repository URL:
+      </div>
+      <div class="col col-md-6">
+          <% if repository_url %>
+              <%
+              repository_link = "<a href=\"#{repository_url}\">#{repository_url}</a>"
+              %>
+
+              <%= Sanitize.fragment(repository_link, Sanitize::Config::BASIC) %>
+          <% end %>
+      </div>
+    </div>
+  </div>
 <% end %>
 
-
+<% if tab == "network" %>
 <script type="text/javascript">
 var windowWidth, windowHeight, svg;
 
@@ -421,5 +466,6 @@ window.onload = function() {
 
     });
 }</script>
+<% end %>
 </body>
 </html>

data/lib/pact_broker/ui/views/index/_dashboard_navbar.haml

@@ -0,0 +1,7 @@
+%nav{'aria-label': 'breadcrumb'}
+  %ol.breadcrumb
+    %li.breadcrumb-item
+      %a{'href': "#{base_url}/"}
+        Home
+    %li.breadcrumb-item.active{'aria-current': 'page'}
+      Pact publications

data/lib/pact_broker/ui/views/index/_navbar.haml

@@ -3,12 +3,5 @@
     .navbar-header
     %ul.navbar-right#top-left-menu
       %li
-        - if tag_toggle
-          %a{href: "#{base_url}?tags=true"}
-            Show latest tags
-        - else
-          %a{href: "#{base_url}/"}
-            Hide latest tags
-
         %a{href: "#{base_url}/hal-browser/browser.html"}
           API Browser

data/lib/pact_broker/ui/views/index/show-with-tags.haml

@@ -52,7 +52,9 @@
               'data-consumer-name': index_item.consumer_name,
               'data-provider-name': index_item.provider_name,
               'data-integration-url': index_item.integration_url,
-              'data-tagged-pacts': index_item.tagged_pacts}
+              'data-pact-tags': index_item.pact_tags,
+              'data-pact-branches': index_item.pact_branches
+              }
             %td.consumer
               %a{:href => index_item.consumer_group_url }
                 = index_item.consumer_name