Executions repo sender (#1158)

Repository and sender in executions endpoint
Consumption calculation at backend side

Author: piotrmilcarz

lib/travis/api/v3/renderer/execution_per_repo.rb

@@ -0,0 +1,6 @@
+module Travis::API::V3
+  class Renderer::ExecutionPerRepo < ModelRenderer
+    representation :minimal, :repository_id, :os, :credits_consumed, :minutes_consumed, :repository
+    representation :standard, *representations[:minimal]
+  end
+end

lib/travis/api/v3/renderer/execution_per_sender.rb

@@ -0,0 +1,6 @@
+module Travis::API::V3
+  class Renderer::ExecutionPerSender < ModelRenderer
+    representation :minimal, :credits_consumed, :minutes_consumed, :sender_id, :sender
+    representation :standard, *representations[:minimal]
+  end
+end

lib/travis/api/v3/renderer/executions_per_repo.rb

@@ -0,0 +1,6 @@
+module Travis::API::V3
+  class Renderer::ExecutionsPerRepo < CollectionRenderer
+    type           :executionsperrepo
+    collection_key :executionsperrepo
+  end
+end

lib/travis/api/v3/renderer/executions_per_sender.rb

@@ -0,0 +1,6 @@
+module Travis::API::V3
+  class Renderer::ExecutionsPerSender < CollectionRenderer
+    type           :executionspersender
+    collection_key :executionspersender
+  end
+end

lib/travis/api/v3/routes.rb

@@ -132,6 +132,16 @@ module Routes
         route '/executions'
         get :for_owner
       end
+
+      resource :executions do
+        route '/executions_per_repo'
+        get :for_owner_per_repo
+      end
+
+      resource :executions do
+        route '/executions_per_sender'
+        get :for_owner_per_sender
+      end
     end
 
     resource :repositories do

lib/travis/api/v3/services/executions/for_owner.rb

@@ -12,8 +12,8 @@ def run!
       raise NotFound unless owner
       raise InsufficientAccess unless access_control.visible?(owner)
 
-      result query(:executions).for_owner(owner, access_control.user.id, params['page'], params['per_page'],
-                                          params['from'], params['to'])
+      result query(:executions).for_owner(owner, access_control.user.id, params['page'] || 0,
+                                          params['per_page'] || 0, params['from'], params['to'])
     end
   end
 end

lib/travis/api/v3/services/executions/for_owner_per_repo.rb

@@ -0,0 +1,48 @@
+module Travis::API::V3
+  class Services::Executions::ForOwnerPerRepo < Service
+    params :from, :to
+    result_type :executions_per_repo
+
+    def run!
+      raise MethodNotAllowed if Travis.config.org?
+      raise LoginRequired unless access_control.logged_in?
+
+      owner = query(:owner).find
+
+      raise NotFound unless owner
+      raise InsufficientAccess unless access_control.visible?(owner)
+
+      results = query(:executions).for_owner(owner, access_control.user.id, 0, 0,
+                                             params['from'], params['to'])
+      result recuce_by_repo(results)
+    end
+
+    def recuce_by_repo(results) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      reduced = []
+      results.each do |item|
+        minutes_consumed = calculate_minutes(item.started_at, item.finished_at)
+        obj = reduced.find { |one| one[:repository_id] == item.repository_id && one[:os] == item.os }
+        if obj
+          obj[:credits_consumed] += item.credits_consumed
+          obj[:minutes_consumed] += minutes_consumed
+        else
+          repo = Travis::API::V3::Models::Repository.find(item.repository_id)
+          reduced << {
+            repository_id: item.repository_id,
+            os: item.os,
+            credits_consumed: item.credits_consumed,
+            minutes_consumed: minutes_consumed,
+            repository: Renderer.render_model(repo, mode: :standard)
+          }
+        end
+      end
+      reduced
+    end
+
+    def calculate_minutes(start, finish)
+      return 0 if finish.to_s.empty?
+
+      ((Time.parse(finish.to_s) - Time.parse(start.to_s)) / 60.to_f).ceil
+    end
+  end
+end

lib/travis/api/v3/services/executions/for_owner_per_sender.rb

@@ -0,0 +1,47 @@
+module Travis::API::V3
+  class Services::Executions::ForOwnerPerSender < Service
+    params :from, :to
+    result_type :executions_per_sender
+
+    def run!
+      raise MethodNotAllowed if Travis.config.org?
+      raise LoginRequired unless access_control.logged_in?
+
+      owner = query(:owner).find
+
+      raise NotFound unless owner
+      raise InsufficientAccess unless access_control.visible?(owner)
+
+      results = query(:executions).for_owner(owner, access_control.user.id, 0, 0,
+                                             params['from'], params['to'])
+      result recuce_by_sender(results)
+    end
+
+    def recuce_by_sender(results) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      reduced = []
+      results.each do |item|
+        minutes_consumed = calculate_minutes(item.started_at, item.finished_at)
+        obj = reduced.find { |one| one[:sender_id] == item.sender_id }
+        if obj
+          obj[:credits_consumed] += item.credits_consumed
+          obj[:minutes_consumed] += minutes_consumed
+        else
+          sender = Travis::API::V3::Models::User.find(item.sender_id)
+          reduced << {
+            credits_consumed: item.credits_consumed,
+            minutes_consumed: minutes_consumed,
+            sender_id: item.sender_id,
+            sender: Renderer.render_model(sender, mode: :standard)
+          }
+        end
+      end
+      reduced
+    end
+
+    def calculate_minutes(start, finish)
+      return 0 if finish.to_s.empty?
+
+      ((Time.parse(finish.to_s) - Time.parse(start.to_s)) / 60.to_f).ceil
+    end
+  end
+end

spec/support/billing_spec_helper.rb

@@ -272,14 +272,14 @@ def billing_executions_response_body(attributes = {})
         'virtualization_type' => 'vm',
         'queue' => 'builds.gce-oss',
         'job_id' => 123,
-        'repository_id' => 123,
+        'repository_id' => 1,
         'owner_id' => 1,
         'owner_type' => 'User',
         'plan_id' => 2,
         'sender_id' => 1,
         'credits_consumed' => 5,
         'started_at' => Time.now,
-        'finished_at' => Time.now,
+        'finished_at' => Time.now + 10.minutes,
         'created_at' => Time.now,
         'updated_at' => Time.now
       }.deep_merge(attributes)

spec/v3/services/v2_subscription/executions_spec.rb

@@ -2,6 +2,7 @@
   let(:parsed_body) { JSON.load(last_response.body) }
   let(:billing_url) { 'http://billingfake.travis-ci.com' }
   let(:billing_auth_key) { 'secret' }
+  let(:repo) { Travis::API::V3::Models::Repository.where(owner_name: 'svenfuchs', name: 'minimal').first }
 
   before do
     Travis.config.host = 'travis-ci.com'
@@ -35,13 +36,15 @@
       stub_request(:get, "#{billing_url}/usage/users/#{user.id}/executions?page=#{page}&per_page=#{per_page}&from=#{from.to_s}&to=#{to.to_s}")
         .with(basic_auth: ['_', billing_auth_key],  headers: { 'X-Travis-User-Id' => user.id })
         .to_return(body: JSON.dump([billing_executions_response_body]))
+      stub_request(:get, "#{billing_url}/usage/users/#{user.id}/executions?page=0&per_page=0&from=#{from.to_s}&to=#{to.to_s}")
+        .with(basic_auth: ['_', billing_auth_key],  headers: { 'X-Travis-User-Id' => user.id })
+        .to_return(body: JSON.dump([billing_executions_response_body]))
     end
 
     it 'responds with list of executions' do
       get("/v3/owner/#{user.login}/executions?page=#{page}&per_page=#{per_page}&from=#{from.to_s}&to=#{to.to_s}", {}, headers)
 
       expect(last_response.status).to eq(200)
-      puts parsed_body
       expect(parsed_body).to eql_json({
         '@type' => 'executions',
         '@href' => "/v3/owner/travis-ci/executions?page=1&per_page=25&from=#{from.to_s}&to=#{to.to_s}",
@@ -56,18 +59,132 @@
           'virtualization_type' => 'vm',
           'queue' => 'builds.gce-oss',
           'job_id' => 123,
-          'repository_id' => 123,
+          'repository_id' => repo.id,
           'owner_id' => 1,
           'owner_type' => 'User',
           'plan_id' => 2,
           'sender_id' => 1,
           'credits_consumed' => 5,
           'started_at' => Time.now.to_s,
-          'finished_at' => Time.now.to_s,
+          'finished_at' => (Time.now + 10.minutes).to_s,
           'created_at' => Time.now.to_s,
           'updated_at' => Time.now.to_s
         }]
       })
     end
+
+    it 'responds with list of executions per repo' do
+      get("/v3/owner/#{user.login}/executions_per_repo?from=#{from.to_s}&to=#{to.to_s}", {}, headers)
+
+      expect(last_response.status).to eq(200)
+      expect(parsed_body).to eql_json({
+        '@type' => 'executionsperrepo',
+        '@href' => "/v3/owner/travis-ci/executions_per_repo?from=#{from.to_s}&to=#{to.to_s}",
+        '@representation' => 'standard',
+        'executionsperrepo' =>
+        [
+          {
+            "repository_id"=>1,
+            "os"=>"linux",
+            "credits_consumed"=>5,
+            "minutes_consumed"=>10,
+            "repository"=>
+            {
+              "@type"=>"repository",
+              "@href"=>"/repo/1",
+              "@representation"=>"standard",
+              "@permissions"=>
+              {
+                "read"=>true,
+                "activate"=>false,
+                "deactivate"=>false,
+                "migrate"=>false,
+                "star"=>false,
+                "unstar"=>false,
+                "create_cron"=>false,
+                "create_env_var"=>false,
+                "create_key_pair"=>false,
+                "delete_key_pair"=>false,
+                "create_request"=>false,
+                "admin"=>false
+              },
+              "id"=>1,
+              "name"=>"minimal",
+              "slug"=>"svenfuchs/minimal",
+              "description"=>nil,
+              "github_id"=>1,
+              "vcs_id"=>nil,
+              "vcs_type"=>"GithubRepository",
+              "github_language"=>nil,
+              "active"=>true,
+              "private"=>false,
+              "owner"=>{"@type"=>"user", "id"=>1, "login"=>"svenfuchs", "@href"=>"/user/1"},
+              "owner_name"=>"svenfuchs",
+              "vcs_name"=>"minimal",
+              "default_branch"=>{"@type"=>"branch", "@href"=>"/repo/1/branch/master", "@representation"=>"minimal", "name"=>"master"},
+              "starred"=>false,
+              "managed_by_installation"=>false,
+              "active_on_org"=>nil,
+              "migration_status"=>nil,
+              "history_migration_status"=>nil,
+              "shared"=>false,
+              "config_validation"=>false
+            }
+          }
+        ]
+      })
+    end
+
+    it 'responds with list of executions per sender' do
+      get("/v3/owner/#{user.login}/executions_per_sender?from=#{from.to_s}&to=#{to.to_s}", {}, headers)
+
+      expect(last_response.status).to eq(200)
+      expect(parsed_body).to eql_json({
+        '@type' => 'executionspersender',
+        '@href' => "/v3/owner/travis-ci/executions_per_sender?from=#{from.to_s}&to=#{to.to_s}",
+        '@representation' => 'standard',
+        'executionspersender' =>
+        [
+          {
+            "credits_consumed"=>5,
+            "minutes_consumed"=>10,
+            "sender_id"=>1,
+            "sender"=>
+            {
+              "@type"=>"user",
+              "@href"=>"/user/1",
+              "@representation"=>"standard",
+              "@permissions"=>{"read"=>true, "sync"=>false},
+              "id"=>1,
+              "login"=>"svenfuchs",
+              "name"=>"Sven Fuchs",
+              "github_id"=>nil,
+              "vcs_id"=>nil,
+              "vcs_type"=>"GithubUser",
+              "avatar_url"=>"https://0.gravatar.com/avatar/07fb84848e68b96b69022d333ca8a3e2",
+              "education"=>nil,
+              "allow_migration"=>false,
+              "allowance"=>
+              {
+                "@type"=>"allowance",
+                "@representation"=>"minimal",
+                "subscription_type"=>1,
+                "public_repos"=>true,
+                "private_repos"=>false,
+                "concurrency_limit"=>1,
+                "user_usage"=>false,
+                "pending_user_licenses"=>false,
+                "id"=>1
+              },
+              "email"=>nil,
+              "is_syncing"=>nil,
+              "synced_at"=>nil,
+              "recently_signed_up"=>false,
+              "secure_user_hash"=>nil
+            }
+          }
+        ]}
+      )
+    end
   end
 end