tractive 1.0.12 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07fb75035716d30de8f58206ad93cd0b932d74807646d5577d519d848eb2bfa0
-  data.tar.gz: c4e50252da3aaf67b919041cdc682e8559abb28163dd847671d30c91808d15e0
+  metadata.gz: 71d04fdb0054f5a9ced6c246dc346d2b9c39f9bf115894805cbd1eb9411c7442
+  data.tar.gz: 59c54357c8495e8e505228d7eb2a65401505704ad208eb553124f637a5eb00f8
 SHA512:
-  metadata.gz: efc63d0e9e8b08d3780cccd3877554c7a1df4408cd8db3c5bcf4fd11634eab73ac7f29fa300fb9191e77a892ba5d795c80e0d1a5a97283e6c541370372ef5725
-  data.tar.gz: b1dc726435943c2b0cf70f369c21ffd049d07e13147a5d88f162dc725fb1ad7d62a8a034b2adb05903cc9e393dd421497af457fbaf2ad8cf45684b783b63b5ba
+  metadata.gz: 2251a5f5cb89a617fcae72eea174736f8df978aa73907b89e7c8a5e4176e2cec9f9ad3e48a12b09f9111cf7ef3a0ede6692fbb1f70b0ef6577e72864b4717875
+  data.tar.gz: 802c59f3396270a1ccc072a13c202fe21b6899e3fe3746d95f1b1cce619fddef878c1f255089e72c21595d0fa06ebae4b2da0f28ea4393675b01fb6528bb006a

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/command_base.rb

@@ -7,5 +7,7 @@ class CommandBase < Thor
                           desc: "Name of the logfile to output logs to."
   class_option "config", type: :string, default: "tractive.config.yaml", banner: "<PATH>", aliases: "-c",
                          desc: "Set the configuration file"
+  class_option "git-token", type: :string,
+                            desc: "The access token for Github actions."
   class_option "verbose", type: :boolean, aliases: ["-v", "--verbose"], desc: "Verbose mode"
 end

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/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

@@ -8,6 +8,11 @@ module Tractive
       @opts = opts
       @cfg  = YAML.load_file(@opts[:config])
 
+      @cfg["github"] ||= {}
+      @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"])
     rescue Sequel::DatabaseConnectionError, Sequel::AdapterNotFound, URI::InvalidURIError, Sequel::DatabaseError => e

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])
         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
@@ -281,7 +285,7 @@ module Migrator
           # text += "created the issue\n\n"
           if body && !body.lstrip.empty?
             # text += "\n___\n" if not append
-            text += @twf_to_markdown.convert(body)
+            text += @twf_to_markdown.convert(body, id: meta[:ticket])
           end
 
         when "comment"
@@ -295,7 +299,7 @@ module Migrator
                   end
 
           text += "\n___\n" unless append
-          text += @twf_to_markdown.convert(body) if body
+          text += @twf_to_markdown.convert(body, id: meta[:ticket]) if body
 
         when "attachment"
           text += "_uploaded file "
@@ -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/converter/twf_to_markdown.rb

@@ -16,11 +16,11 @@ module Migrator
 
         @git_repo = options[:git_repo]
         @home_page_name = options[:home_page_name]
-        @wiki_extensions = options[:wiki_extensions] # || [".py", "changelog", "expire-ids"]
-        @source_folders = options[:source_folders] # || %w[personal attic sprint branch/hawk]
+        @wiki_extensions = options[:wiki_extensions]
+        @source_folders = options[:source_folders]
       end
 
-      def convert(str)
+      def convert(str, image_options = {})
         # Fix 'Windows EOL' to 'Linux EOL'
         str.gsub!("\r\n", "\n")
 
@@ -33,7 +33,7 @@ module Migrator
         convert_links(str, @git_repo)
         convert_font_styles(str)
         convert_changeset(str, @changeset_base_url)
-        convert_image(str, @base_url, @attach_url, @wiki_attachments_url)
+        convert_image(str, @base_url, @attach_url, @wiki_attachments_url, image_options)
         convert_ticket(str, @base_url)
         revert_intermediate_references(str)
 
@@ -247,13 +247,13 @@ module Migrator
       def file?(trac_path)
         return false unless trac_path
 
-        @wiki_extensions.any? { |extension| trac_path.end_with?(extension) }
+        @wiki_extensions&.any? { |extension| trac_path.end_with?(extension) }
       end
 
       def wiki_path(path, line_number = "")
         # TODO: This will not work for folders given in the source_folder parameter and
         # will not work for subfolders paths like `personal/rjs` unless given in the parameters.
-        return "branches/all?query=#{path}" if @source_folders.any? { |folder| folder == path }
+        return "branches/all?query=#{path}" if @source_folders&.any? { |folder| folder == path }
         return index_paths[path] if index_paths[path]
 
         prefix = if file?(path)
@@ -294,7 +294,7 @@ module Migrator
         "[#{wiki_name}](https://github.com/#{git_repo}/wiki/#{wiki_name})"
       end
 
-      def convert_image(str, base_url, attach_url, wiki_attachments_url)
+      def convert_image(str, base_url, attach_url, wiki_attachments_url, options = {})
         # https://trac.edgewall.org/wiki/WikiFormatting#Images
         # [[Image(picture.gif)]] Current page (Ticket, Wiki, Comment)
         # [[Image(wiki:WikiFormatting:picture.gif)]] (referring to attachment on another page)
@@ -316,7 +316,15 @@ module Migrator
                               # [[Image(http://example.org/s.jpg)]]
                               "!{{#{path}}}(#{path})"
                             else
-                              _, id, file = path.split(":")
+                              tmp = path.split(":")
+                              id, file = case tmp.size
+                                         when 3
+                                           [tmp[1], tmp[2]]
+                                         when 2
+                                           tmp
+                                         else
+                                           [options[:id].to_s, tmp[0]]
+                                         end
                               file_path = "#{attach_url}/#{Tractive::Utilities.attachment_path(id, file, hashed: @attach_hashed)}"
                               "!{{#{path}}}(#{file_path})"
                             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/migrator/wikis/migrate_from_db.rb

@@ -63,7 +63,7 @@ module Migrator
             $logger.info("Working with file [#{file_name}]")
             $logger.debug("Object: #{wiki}")
 
-            wiki_markdown_text = @twf_to_markdown.convert(wiki[:text])
+            wiki_markdown_text = @twf_to_markdown.convert(wiki[:text], id: wiki[:name])
             wiki_markdown_text += wiki_attachments(wiki)
 
             # Create file with content

data/lib/tractive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tractive
-  VERSION = "1.0.12"
+  VERSION = "1.0.16"
 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.12
+  version: 1.0.16
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-01-24 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