abt-cli 0.0.8 → 0.0.13

data/lib/abt/providers/devops.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.expand_path(__dir__)}/devops/*.rb").sort.each { |file| require file }
+Dir.glob("#{File.expand_path(__dir__)}/devops/commands/*.rb").sort.each { |file| require file }
+
+module Abt
+  module Providers
+    module Devops
+      def self.command_names
+        Commands.constants.sort.map { |constant_name| Helpers.const_to_command(constant_name) }
+      end
+
+      def self.command_class(name)
+        const_name = Helpers.command_to_const(name)
+        Commands.const_get(const_name) if Commands.const_defined?(const_name)
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/api.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      class Api
+        VERBS = %i[get post put].freeze
+
+        CONDITIONAL_ACCESS_POLICY_ERROR_CODE = 'VS403463'
+
+        attr_reader :organization_name, :project_name, :username, :access_token, :cli
+
+        def initialize(organization_name:, project_name:, username:, access_token:, cli:)
+          @organization_name = organization_name
+          @project_name = project_name
+          @username = username
+          @access_token = access_token
+          @cli = cli
+        end
+
+        VERBS.each do |verb|
+          define_method(verb) do |*args|
+            request(verb, *args)
+          end
+        end
+
+        def get_paged(path, query = {})
+          result = request(:get, path, query)
+          result['value']
+
+          # TODO: Loop if necessary
+        end
+
+        def work_item_query(wiql)
+          response = post('wit/wiql', Oj.dump({ query: wiql }, mode: :json))
+          ids = response['workItems'].map { |work_item| work_item['id'] }
+
+          work_items = []
+          ids.each_slice(200) do |page_ids|
+            work_items += get_paged('wit/workitems', ids: page_ids.join(','))
+          end
+
+          work_items
+        end
+
+        def request(*args)
+          response = connection.public_send(*args)
+
+          if response.success?
+            Oj.load(response.body)
+          else
+            error_class = Abt::HttpError.error_class_for_status(response.status)
+            encoded_response_body = response.body.force_encoding('utf-8')
+            raise error_class, "Code: #{response.status}, body: #{encoded_response_body}"
+          end
+        rescue Abt::HttpError::ForbiddenError => e
+          handle_denied_by_conditional_access_policy!(e)
+        end
+
+        def base_url
+          "https://#{organization_name}.visualstudio.com/#{project_name}"
+        end
+
+        def api_endpoint
+          "#{base_url}/_apis"
+        end
+
+        def url_for_work_item(work_item)
+          "#{base_url}/_workitems/edit/#{work_item['id']}"
+        end
+
+        def connection
+          @connection ||= Faraday.new(api_endpoint) do |connection|
+            connection.basic_auth username, access_token
+            connection.headers['Content-Type'] = 'application/json'
+            connection.headers['Accept'] = 'application/json; api-version=6.0'
+          end
+        end
+
+        private
+
+        def handle_denied_by_conditional_access_policy!(exception)
+          raise exception unless exception.message.include?(CONDITIONAL_ACCESS_POLICY_ERROR_CODE)
+
+          cli.abort <<~TXT
+            Access denied by conditional access policy.
+            Try logging into the board using the URL below, then retry the command.
+
+            #{base_url}
+          TXT
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/base_command.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      class BaseCommand
+        attr_reader :arg_str, :organization_name, :project_name, :board_id, :work_item_id, :cli, :config
+
+        def initialize(arg_str:, cli:)
+          @arg_str = arg_str
+
+          @config = Configuration.new(cli: cli)
+          @cli = cli
+
+          if arg_str.nil?
+            use_current_args
+          else
+            use_arg_str(arg_str)
+          end
+        end
+
+        private
+
+        def require_board!
+          return if organization_name && project_name && board_id
+
+          cli.abort 'No current/specified board. Did you initialize DevOps?'
+        end
+
+        def require_work_item!
+          unless organization_name && project_name && board_id
+            cli.abort 'No current/specified board. Did you initialize DevOps and pick a work item?'
+          end
+
+          return if work_item_id
+
+          cli.abort 'No current/specified work item. Did you pick a DevOps work item?'
+        end
+
+        def sanitize_work_item(work_item)
+          return nil if work_item.nil?
+
+          work_item.merge(
+            'id' => work_item['id'].to_s,
+            'name' => work_item['fields']['System.Title'],
+            'url' => api.url_for_work_item(work_item)
+          )
+        end
+
+        def same_args_as_config?
+          organization_name == config.organization_name &&
+            project_name == config.project_name &&
+            board_id == config.board_id &&
+            work_item_id == config.work_item_id
+        end
+
+        def print_board(organization_name, project_name, board)
+          arg_str = "#{organization_name}/#{project_name}/#{board['id']}"
+
+          cli.print_provider_command('devops', arg_str, board['name'])
+          # cli.warn board['url'] if board.key?('url') && cli.output.isatty # TODO: Web URL
+        end
+
+        def print_work_item(organization, project, board, work_item)
+          arg_str = "#{organization}/#{project}/#{board['id']}/#{work_item['id']}"
+
+          cli.print_provider_command('devops', arg_str, work_item['name'])
+          cli.warn work_item['url'] if work_item.key?('url') && cli.output.isatty
+        end
+
+        def use_current_args
+          @organization_name = config.organization_name
+          @project_name = config.project_name
+          @board_id = config.board_id
+          @work_item_id = config.work_item_id
+        end
+
+        def use_arg_str(arg_str)
+          args = arg_str.to_s.split('/')
+
+          if args.length < 3
+            cli.abort 'Argument format is <organization>/<project>/<board-id>[/<work-item-id>]'
+          end
+
+          (@organization_name, @project_name, @board_id, @work_item_id) = args
+        end
+
+        def api
+          Abt::Providers::Devops::Api.new(organization_name: organization_name,
+                                          project_name: project_name,
+                                          username: config.username_for_organization(organization_name),
+                                          access_token: config.access_token_for_organization(organization_name),
+                                          cli: cli)
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/boards.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Boards < BaseCommand
+          def self.command
+            'boards devops'
+          end
+
+          def self.description
+            'List all boards - useful for piping into grep etc'
+          end
+
+          def call
+            cli.abort 'No organization selected. Did you initialize DevOps?' if organization_name.nil?
+            cli.abort 'No project selected. Did you initialize DevOps?' if project_name.nil?
+
+            boards.map do |board|
+              print_board(organization_name, project_name, board)
+            end
+          end
+
+          private
+
+          def boards
+            @boards ||= api.get_paged('work/boards')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/clear.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Clear < BaseCommand
+          def self.command
+            'clear devops'
+          end
+
+          def self.description
+            'Clear DevOps config for current git repository'
+          end
+
+          def call
+            cli.warn 'Clearing configuration'
+            config.clear_local
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/clear_global.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class ClearGlobal < BaseCommand
+          def self.command
+            'clear-global devops'
+          end
+
+          def self.description
+            'Clear all global configuration'
+          end
+
+          def call
+            cli.warn 'Clearing global DevOps configuration'
+            config.clear_global
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/current.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class Current < BaseCommand
+          def self.command
+            'current devops[:<organization-name>/<project-name>/<board-id>[/<work-item-id>]]'
+          end
+
+          def self.description
+            'Get or set DevOps configuration for current git repository'
+          end
+
+          def call
+            require_board!
+
+            if same_args_as_config? || !config.local_available?
+              show_current_configuration
+            else
+              cli.warn 'Updating configuration'
+              update_configuration
+            end
+          end
+
+          private
+
+          def show_current_configuration
+            if work_item_id.nil?
+              print_board(organization_name, project_name, board)
+            else
+              print_work_item(organization_name, project_name, board, work_item)
+            end
+          end
+
+          def update_configuration
+            ensure_board_is_valid!
+
+            if work_item_id.nil?
+              update_board_config
+              config.work_item_id = nil
+
+              print_board(organization_name, project_name, board)
+            else
+              ensure_work_item_is_valid!
+
+              update_board_config
+              config.work_item_id = work_item_id
+
+              print_work_item(organization_name, project_name, board, work_item)
+            end
+          end
+
+          def update_board_config
+            config.organization_name = organization_name
+            config.project_name = project_name
+            config.board_id = board_id
+          end
+
+          def ensure_board_is_valid!
+            if board.nil?
+              cli.abort 'Board could not be found, ensure that settings for organization, project, and board are correct'
+            end
+          end
+
+          def ensure_work_item_is_valid!
+            cli.abort "No such work item: ##{work_item_id}" if work_item.nil?
+          end
+
+          def board
+            @board ||= begin
+                         cli.warn 'Fetching board...'
+                         api.get("work/boards/#{board_id}")
+                       rescue HttpError::NotFoundError
+                         nil
+                       end
+          end
+
+          def work_item
+            @work_item ||= begin
+                             cli.warn 'Fetching work item...'
+                             work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+                             sanitize_work_item(work_item)
+                           rescue HttpError::NotFoundError
+                             nil
+                           end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/abt/providers/devops/commands/harvest_time_entry_data.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Abt
+  module Providers
+    module Devops
+      module Commands
+        class HarvestTimeEntryData < BaseCommand
+          def self.command
+            'harvest-time-entry-data devops[:<organization-name>/<project-name>/<board-id>/<work-item-id>]'
+          end
+
+          def self.description
+            'Print Harvest time entry data for DevOps work item as json. Used by harvest start script.'
+          end
+
+          def call
+            require_work_item!
+
+            body = {
+              notes: notes,
+              external_reference: {
+                id: work_item['id'],
+                group_id: 'AzureDevOpsWorkItem',
+                permalink: work_item['url']
+              }
+            }
+
+            cli.puts Oj.dump(body, mode: :json)
+          end
+
+          private
+
+          def notes
+            [
+              'Azure DevOps',
+              work_item['fields']['System.WorkItemType'],
+              "##{work_item['id']}",
+              '-',
+              work_item['name']
+            ].join(' ')
+          end
+
+          def work_item
+            @work_item ||= begin
+              work_item = api.get_paged('wit/workitems', ids: work_item_id)[0]
+              sanitize_work_item(work_item)
+            end
+          end
+        end
+      end
+    end
+  end
+end