tractive 1.0.14 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0db013dccdcc48d417706b5f52036b4c5801b4d81d6a835c09ee4b1afc6480db
-  data.tar.gz: 4603e9e32107e75a4e2f495dc4a93cbc4e810a65c2bee576721e7d58d4be78cd
+  metadata.gz: e08becfcae314c82bdc793b7eb6bc2f7b52f9a7be040b7141da825753a9f1af2
+  data.tar.gz: 51385bdf7fcf7b12b110c852b9d0b9dc277240abf0b8c2f94b68b77db2839c32
 SHA512:
-  metadata.gz: 5cf948f6fd3aed7f3b67778e91e9d88e7e1f9586824e21c4a1a0a4a42b42a14eedac4df7d5bf7627e182741ccf35865e195c1990c18e008b352b43bee08d4f4a
-  data.tar.gz: f2b76c16fdf603a4d084df7a895f6ffdef16b4fc9297e6f039d9894e4b95a14a6d31ef090399983f46e68f4b904485df41102f3749926aef8adffee8e7d4011a
+  metadata.gz: ad89e67997dd07cb3b6d65c5baca788033991122d8a10a73a64b09df79695ed8e2488b033dfaaa5fdd07d4a65c4ee5b4230121f3f7f094c8286bce352bcd6118
+  data.tar.gz: 04f60f8190dbc644367c3095f28e4f7fddba04dfa5140a820dfbced58430fb3b1df1bb9c72dd10dadba6e4f66e1cfe9a2ea57f647bbf982452643824e87622f8

data/.rubocop.yml

@@ -36,7 +36,7 @@ Metrics/MethodLength:
   Enabled: false
 
 Metrics/ModuleLength:
-  Max: 150
+  Max: 250
 
 Metrics/ParameterLists:
   Max: 6

data/README.adoc

@@ -506,6 +506,8 @@ milestones:
 ==== Attachments migration configuration
 `ticket | wiki:`:: specifies the options for the tickets or wikis
 
+  `delete_mocked:`::: Whether to delete mocked tickets after migration or not
+
   `attachments:`::: specifies method of obtaining attachments from Trac.
 
     `url:`:::: URL to obtain Trac attachments from
@@ -517,9 +519,12 @@ milestones:
     `export_script:`:::: output of a script that utilizes `trac-admin` to download 
     all attachments from Trac.
 
+NOTE: To delete the issues, an organization owner must enable deleting an issue for the organization's repositories, and you must have admin or owner permissions in the repository. For more information, see "https://docs.github.com/en/issues/tracking-your-work-with-issues/deleting-an-issue[deleting an issue]". 
+
 [source,yaml]
 ----
 ticket:
+  delete_mocked: true
   attachments:
     url: https://abc.com/raw-attachment/ticket
     hashed: true

data/exe/tractive

@@ -47,6 +47,8 @@ class TractiveCommand < CommandBase
                               desc: "Put all issue comments in the first message."
   method_option "start", type: :numeric, aliases: ["-s", "--start-at"], banner: "<ID>",
                          desc: "Start migration from ticket with number <ID>"
+  method_option "make-owners-labels", type: :boolean,
+                                      desc: "If true, this will make a tag like `owner:<owner name>` and add it to the issue."
   def migrate_tickets
     Tractive::Main.new(options).run
   end

data/lib/tractive/github_api/graph_ql_client/issues.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GithubApi
+  class GraphQlClient
+    # Methods for the Issues API
+    module Issues
+      DELETE_ISSUE_QUERY = <<~QUERY
+        mutation ($input: DeleteIssueInput!) {
+          deleteIssue(input: $input) {
+            repository {
+              name
+              url
+            }
+          }
+        }
+      QUERY
+
+      def delete_issue(issue_id)
+        variables = {
+          "input" => {
+            "issueId" => issue_id
+          }
+        }
+
+        Client.query(DeleteIssueQuery, variables: variables)
+      end
+    end
+  end
+end

data/lib/tractive/github_api/graph_ql_client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "graph_ql_client/issues"
+
+require "graphql/client"
+require "graphql/client/http"
+
+# Service to perform github actions
+module GithubApi
+  class GraphQlClient
+    include GithubApi::GraphQlClient::Issues
+
+    HttpAdapter = GraphQL::Client::HTTP.new("https://api.github.com/graphql") do
+      attr_writer :token
+
+      def headers(_context)
+        {
+          "Authorization" => "bearer #{@token}"
+        }
+      end
+    end
+
+    def self.add_constants(token)
+      HttpAdapter.token = token
+
+      GithubApi::GraphQlClient.const_set("Schema", GraphQL::Client.load_schema(HttpAdapter))
+      GithubApi::GraphQlClient.const_set("Client", GraphQL::Client.new(schema: Schema, execute: HttpAdapter))
+      GithubApi::GraphQlClient.const_set("DeleteIssueQuery", Client.parse(DELETE_ISSUE_QUERY))
+    end
+  end
+end

data/lib/tractive/github_api.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "github_api/client"
+require_relative "github_api/graph_ql_client"

data/lib/tractive/http/client/request.rb

@@ -22,7 +22,7 @@ module Http
             minutes = retry_after / 60
             seconds = retry_after % 60
 
-            print "\rRate Limit Exceeded, Will retry in #{minutes} min #{seconds} sec"
+            $logger.info "Rate Limit Exceeded, Will retry in #{minutes} min #{seconds} sec"
             sleep(1)
 
             retry_after = e.http_headers[:x_ratelimit_reset].to_i - Time.now.to_i

data/lib/tractive/info.rb

@@ -29,12 +29,25 @@ module Tractive
       priorities  = Ticket.distinct.select(:priority).select_map(:priority).compact
       tracstates  = Ticket.distinct.select(:status).select_map(:status).compact
 
+      keywords    = Ticket.distinct
+                          .select(:keywords)
+                          .select_map(:keywords)
+                          .map do |keyword|
+                            keyword&.split(",")&.map do |k|
+                              k.strip.gsub(" ", "_")
+                            end
+                          end
+                          .flatten
+                          .uniq
+                          .compact
+
       {
         "users" => Utilities.make_each_hash(users, %w[email name username]),
         "milestones" => milestones,
         "labels" => {
           "type" => Utilities.make_hash("type_", types),
           "resolution" => Utilities.make_hash("resolution_", resolutions),
+          "keywords" => Utilities.make_hash("keyword_", keywords),
           "component" => Utilities.make_each_hash(components, %w[name color], "component: "),
           "severity" => Utilities.make_each_hash(severity, %w[name color]),
           "priority" => Utilities.make_each_hash(priorities, %w[name color]),

data/lib/tractive/main.rb

@@ -9,7 +9,9 @@ module Tractive
       @cfg  = YAML.load_file(@opts[:config])
 
       @cfg["github"] ||= {}
-      @cfg["github"]["token"] = @opts["git-token"]
+      @cfg["github"]["token"] = @opts["git-token"] if @opts["git-token"]
+
+      GithubApi::GraphQlClient.add_constants(@cfg["github"]["token"]) unless @opts[:info]
 
       Tractive::Utilities.setup_logger(output_stream: @opts[:logfile] || $stderr, verbose: @opts[:verbose])
       @db = Tractive::Utilities.setup_db!(@opts["trac-database-path"] || @cfg["trac"]["database"])

data/lib/tractive/migrator/converter/trac_to_github.rb

@@ -16,6 +16,7 @@ module Migrator
         @client               = GithubApi::Client.new(access_token: args[:cfg]["github"]["token"])
         @wiki_attachments_url = args[:cfg].dig("wiki", "attachments", "url")
         @revmap_file_path     = args[:opts][:revmapfile] || args[:cfg]["revmap_path"]
+        @make_owners_label    = args[:opts]["make-owners-labels"] || args[:cfg]["make_owners_labels"]
         @attachment_options   = {
           url: @attachurl,
           hashed: args[:cfg].dig("ticket", "attachments", "hashed")
@@ -101,14 +102,11 @@ module Migrator
 
         labels.delete(nil)
 
-        keywords = ticket[:keywords]
-        if keywords
-          if ticket[:keywords].downcase == "discuss"
-            labels.add(@labels_cfg.fetch("keywords", {})[ticket[:keywords].downcase])
-          else
-            badges.add(@labels_cfg.fetch("keywords", {})[ticket[:keywords]])
-          end
+        keywords = ticket[:keywords]&.split(",") || []
+        keywords.each do |keyword|
+          badges.add(@labels_cfg.fetch("keywords", {})[keyword.strip.gsub(" ", "_")])
         end
+
         # If the field is not set, it will be nil and generate an unprocessable json
 
         milestone = @milestonemap[ticket[:milestone]]
@@ -121,6 +119,14 @@ module Migrator
 
         github_assignee = map_assignee(ticket[:owner])
 
+        unless github_assignee.nil? || github_assignee.empty?
+          if @make_owners_label
+            labels.add("name" => "owner:#{github_assignee}")
+          else
+            badges.add("owner:#{github_assignee}")
+          end
+        end
+
         badges     = badges.to_a.compact.sort
         badgetable = badges.map { |i| %(`#{i}`) }.join(" ")
         badgetable += begin
@@ -132,8 +138,6 @@ module Migrator
 
         # compose body
         body = [badgetable, body, footer].join("\n\n___\n")
-
-        labels.add("name" => "owner:#{github_assignee}") unless github_assignee.nil? || github_assignee.empty?
         labels = labels.map { |label| label["name"] }
 
         issue = {
@@ -265,7 +269,7 @@ module Migrator
         end
 
         case kind
-        when "owner", "status", "title", "resolution", "priority", "component", "type", "severity", "platform", "milestone"
+        when "owner", "status", "title", "resolution", "priority", "component", "type", "severity", "platform", "milestone", "keywords"
           old = meta[:oldvalue]
           new = meta[:newvalue]
           if old && new
@@ -345,7 +349,7 @@ module Migrator
       end
 
       def interested_in_change?(kind, newvalue)
-        !(%w[keywords cc reporter version].include?(kind) ||
+        !(%w[cc reporter version].include?(kind) ||
           (kind == "comment" && (newvalue.nil? || newvalue.lstrip.empty?)))
       end
 

data/lib/tractive/migrator/engine/migrate_from_db.rb

@@ -23,6 +23,7 @@ module Migrator
         begin
           lasttracid = tractickets.last[:id]
         rescue StandardError
+          delete_mocked_tickets if can_delete_mocked_tickets?
           raise("trac has no ticket #{start_ticket}")
         end
 
@@ -89,6 +90,46 @@ module Migrator
 
           @last_created_issue = ticket[:id]
         end
+
+        delete_mocked_tickets if can_delete_mocked_tickets?
+      end
+
+      def can_delete_mocked_tickets?
+        @delete_mocked_tickets
+      end
+
+      def delete_mocked_tickets
+        page = 1
+        issues = @client.issues(@repo, { filter: "all",
+                                         state: "closed",
+                                         page: page })
+
+        until issues.empty?
+          deleted = false
+
+          issues.each do |issue|
+            next if issue["title"] != "Placeholder issue #{issue["number"]} created to align Github issue and trac ticket numbers during migration."
+
+            response = @graph_ql_client.delete_issue(issue["node_id"])
+
+            if response.data.errors.any?
+              error_message = response.data
+                                      .errors
+                                      .messages
+                                      .map { |k, v| "#{k}: #{v}" }
+                                      .join(", ")
+              raise StandardError, error_message
+            end
+
+            deleted = true
+            puts "Successfully deleted issue ##{issue["number"]}, Title: #{issue["title"]}"
+          end
+
+          page += 1 unless deleted
+          issues = @client.issues(@repo, { filter: "all",
+                                           state: "closed",
+                                           page: page })
+        end
       end
     end
   end

data/lib/tractive/migrator/engine.rb

@@ -32,6 +32,7 @@ module Migrator
       @trac  = Tractive::Trac.new(db)
       @repo  = github["repo"]
       @client = GithubApi::Client.new(access_token: github["token"])
+      @graph_ql_client = GithubApi::GraphQlClient.new
 
       if input_file_name
         @from_file = input_file_name
@@ -62,6 +63,7 @@ module Migrator
       @safetychecks     = safetychecks
       @start_ticket     = (start_ticket || (@last_created_issue + 1)).to_i
       @filter_closed    = filter_closed
+      @delete_mocked_tickets = args[:cfg]["ticket"]["delete_mocked"]
     end
 
     def migrate

data/lib/tractive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tractive
-  VERSION = "1.0.14"
+  VERSION = "1.0.18"
 end

data/tractive.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "graphql", "1.13.3"
+  spec.add_dependency "graphql-client"
   spec.add_dependency "mysql2"
   spec.add_dependency "ox"
   spec.add_dependency "rest-client"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tractive
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.18
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.13.3
+- !ruby/object:Gem::Dependency
+  name: graphql-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +173,8 @@ files:
 - lib/tractive/github_api/client/issues.rb
 - lib/tractive/github_api/client/labels.rb
 - lib/tractive/github_api/client/milestones.rb
+- lib/tractive/github_api/graph_ql_client.rb
+- lib/tractive/github_api/graph_ql_client/issues.rb
 - lib/tractive/graceful_quit.rb
 - lib/tractive/http/client.rb
 - lib/tractive/http/client/request.rb