dradis-projects 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90db5bdbaa4c04377872ec12be70cefa3a0fd9b6ccbb6209582544e3b3d8c087
-  data.tar.gz: cad1d32b126fa14b97a7ac688550f3d289c69c93a9a0e3532d127f1c111df5ef
+  metadata.gz: 9233fc43a3d7192fca87e9265e313957c6ab9baf6f08c98a6d467ef9dcd0f87e
+  data.tar.gz: fdbb00a7b191e097a82210ca270c9534e2ccae599784712b8b3c9ef32487a4e0
 SHA512:
-  metadata.gz: c6365cfcd57941f704095989bb1e1ae5bb39b8aa14d93d5df40346ab87db12fa688de1108887c4009f785cc101c83b5090515117710e9bc7ff9d9dc722c106e3
-  data.tar.gz: 8ed81aee751634225e040ec1cca1d942195050ee1734eaab0fa233a66e2eaf096d69c4b238e94d1117f3a97def6c9e20f4189e6d07fe97099df235c1627ad857
+  metadata.gz: f15a496f28939ec492dccd6b3c8dc6d7f1aac465b732bd4e0b9c2efafdf73a0ba02fa02b81499ebbeac990a5d0e682667d225c5b2d8286eb6f22e01e3efcf1de
+  data.tar.gz: f1fbb7e02207d9d50791ebd40c030983e7dafae7f01ab0c629520098beb268a2f72b312f6dd14149ddbd35a0383810ba8095201ff394e2ce5f42c1029f4b200a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+v5.4.0 (September 2026)
+  - Preserve Evidence's review state when exporting and re-importing a project (project backup/restore and Clone project)
+
 v5.3.0 (August 2026)
   - Fix error handling of the package upload when an invalid template is found
 

data/lib/dradis/plugins/projects/export/package.rb

@@ -14,7 +14,7 @@ module Dradis::Plugins::Projects::Export
 
       logger.debug{ "Creating a new Zip file in #{filename}..." }
 
-      Zip::File.open(filename, Zip::File::CREATE) do |zipfile|
+      Zip::File.open(filename, create: true) do |zipfile|
         @project.nodes.each do |node|
           node_path = Attachment.pwd.join(node.id.to_s)
 

data/lib/dradis/plugins/projects/export/v4/template.rb

@@ -39,6 +39,7 @@ module Dradis::Plugins::Projects::Export::V4
           evidences_builder.evidence do |evidence_builder|
             evidence_builder.id(evidence.id)
             evidence_builder.author(evidence.author)
+            evidence_builder.state(evidence.state)
             evidence_builder.tag!('issue-id', evidence.issue_id)
             evidence_builder.content do
               evidence_builder.cdata!(evidence.content)

data/lib/dradis/plugins/projects/gem_version.rb

@@ -8,7 +8,7 @@ module Dradis
 
       module VERSION
         MAJOR = 5
-        MINOR = 3
+        MINOR = 4
         TINY = 0
         PRE = nil
 

data/lib/dradis/plugins/projects/upload/v4/template.rb

@@ -88,10 +88,10 @@ module Dradis::Plugins::Projects::Upload::V4
       def create_issue(issue, xml_issue)
         # TODO: Need to find some way of checking for dups
         # May be combination of text, category_id and created_at
-        issue.author   = xml_issue.at_xpath('author').text.strip
-        issue.state    = xml_issue.at_xpath('state')&.text || :published
-        issue.text     = xml_issue.at_xpath('text').text
-        issue.node     = project.issue_library
+        issue.author = xml_issue.at_xpath('author').text.strip
+        issue.state = xml_issue.at_xpath('state')&.text || :published
+        issue.text = xml_issue.at_xpath('text').text
+        issue.node = project.issue_library
         issue.category = Category.issue
 
         return false unless validate_and_save(issue)
@@ -169,8 +169,8 @@ module Dradis::Plugins::Projects::Upload::V4
         logger.info { 'Processing Categories...' }
 
         template.xpath('dradis-template/categories/category').each do |xml_category|
-          old_id   = Integer(xml_category.at_xpath('id').text.strip)
-          name     = xml_category.at_xpath('name').text.strip
+          old_id = Integer(xml_category.at_xpath('id').text.strip)
+          name = xml_category.at_xpath('name').text.strip
           category = nil
 
           # Prevent creating duplicate categories
@@ -210,7 +210,7 @@ module Dradis::Plugins::Projects::Upload::V4
 
       def parse_methodologies(template)
         methodology_category = Category.default
-        methodology_library  = project.methodology_library
+        methodology_library = project.methodology_library
 
         logger.info { 'Processing Methodologies...' }
 
@@ -224,10 +224,10 @@ module Dradis::Plugins::Projects::Upload::V4
           # MethodologiesController#create action (i.e. 'methodology builder' is
           # used).
           Note.create!(
-            author:      'methodology importer',
-            node_id:     methodology_library.id,
+            author: 'methodology importer',
+            node_id: methodology_library.id,
             category_id: methodology_category.id,
-            text:        xml_methodology.at_xpath('text').text
+            text: xml_methodology.at_xpath('text').text
           )
         end
 
@@ -235,18 +235,18 @@ module Dradis::Plugins::Projects::Upload::V4
       end
 
       def parse_node(xml_node)
-        element   = xml_node.at_xpath('type-id')
-        type_id   = element.text.nil? ? nil : element.text.strip
-        label     = xml_node.at_xpath('label').text.strip
-        element   = xml_node.at_xpath('parent-id')
+        element = xml_node.at_xpath('type-id')
+        type_id = element.text.nil? ? nil : element.text.strip
+        label = xml_node.at_xpath('label').text.strip
+        element = xml_node.at_xpath('parent-id')
         parent_id = element.text.blank? ? nil : element.text.strip
 
         # Node positions
-        element  = xml_node.at_xpath('position')
+        element = xml_node.at_xpath('position')
         position = (element && !element.text.nil?) ? element.text.strip : nil
 
         # Node properties
-        element    = xml_node.at_xpath('properties')
+        element = xml_node.at_xpath('properties')
         properties = (element && !element.text.blank?) ? element.text.strip : nil
 
         created_at = xml_node.at_xpath('created-at')
@@ -271,10 +271,10 @@ module Dradis::Plugins::Projects::Upload::V4
           has_nil_parent = !parent_id
           node =
             project.nodes.new(
-              type_id:   type_id,
-              label:     label,
+              type_id: type_id,
+              label: label,
               parent_id: parent_id,
-              position:  position
+              position: position
             )
           node.save!(validate: has_nil_parent)
           pending_changes[:orphan_nodes]  << node if parent_id
@@ -325,16 +325,17 @@ module Dradis::Plugins::Projects::Upload::V4
             updated_at  = xml_evidence.at_xpath('updated-at')
 
             evidence = Evidence.new(
-                         author:   xml_evidence.at_xpath('author').text.strip,
-                         node_id:  node.id,
-                         content:  xml_evidence.at_xpath('content').text,
-                         issue_id: xml_evidence.at_xpath('issue-id').text.strip
+                         author: xml_evidence.at_xpath('author').text.strip,
+                         node_id: node.id,
+                         content: xml_evidence.at_xpath('content').text,
+                         issue_id: xml_evidence.at_xpath('issue-id').text.strip,
+                         state: xml_evidence.at_xpath('state')&.text || :published
                        )
 
             evidence.update_attribute(:created_at, created_at.text.strip) if created_at
             evidence.update_attribute(:updated_at, updated_at.text.strip) if updated_at
 
-            pending_changes[:evidence]          << evidence
+            pending_changes[:evidence] << evidence
             pending_changes[:evidence_activity] << xml_evidence.xpath('activities/activity')
             pending_changes[:evidence_comments] << xml_evidence.xpath('comments/comment')
 
@@ -355,10 +356,10 @@ module Dradis::Plugins::Projects::Upload::V4
 
             logger.info { "Note category rewrite, used to be #{old_id}, now is #{new_id}" }
             note = Note.create!(
-                     author:      xml_note.at_xpath('author').text.strip,
-                     node_id:     node.id,
+                     author: xml_note.at_xpath('author').text.strip,
+                     node_id: node.id,
                      category_id: new_id,
-                     text:        xml_note.at_xpath('text').text
+                     text: xml_note.at_xpath('text').text
                    )
 
             note.update_attribute(:created_at, created_at.text.strip) if created_at
@@ -466,14 +467,14 @@ module Dradis::Plugins::Projects::Upload::V4
       #
       # Returns nothing, but creates a new Assignee for this card.
       def create_assignee(card, xml_assignee)
-        email   = xml_assignee.text()
+        email = xml_assignee.text()
         user_id = user_id_for_email(email)
 
         if user_id == -1
           old_assignee_field = card.fields['FormerAssignees'] || ''
           card.set_field 'FormerAssignees', old_assignee_field << "* #{email}\n"
         else
-          old_assignee_ids  = card.assignee_ids
+          old_assignee_ids = card.assignee_ids
           card.assignee_ids = old_assignee_ids + [user_id]
         end
       end
@@ -572,8 +573,8 @@ module Dradis::Plugins::Projects::Upload::V4
       def process_methodologies(template)
         logger.info { 'Processing Methodologies...' }
 
-        lookup_table[:cards]    = {}
-        lookup_table[:lists]    = {}
+        lookup_table[:cards] = {}
+        lookup_table[:lists] = {}
         pending_changes[:cards] = []
         pending_changes[:lists] = []
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dradis-projects
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Daniel Martin
@@ -99,13 +99,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/pull_request_template.md"
-- ".gitignore"
-- ".ruby-version"
 - CHANGELOG.md
-- CHANGELOG.template
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -114,7 +108,6 @@ files:
 - app/views/dradis/plugins/projects/export/_index-content.html.erb
 - app/views/dradis/plugins/projects/export/_index-tabs.html.erb
 - config/routes.rb
-- dradis-projects.gemspec
 - lib/dradis-projects.rb
 - lib/dradis/plugins/projects.rb
 - lib/dradis/plugins/projects/engine.rb
@@ -133,24 +126,6 @@ files:
 - lib/dradis/plugins/projects/upload/v4/template.rb
 - lib/dradis/plugins/projects/version.rb
 - lib/tasks/thorfile.rb
-- spec/fixtures/files/attachments_url.xml
-- spec/fixtures/files/invalid_byte_recoverable.xml
-- spec/fixtures/files/malformed_ids.xml
-- spec/fixtures/files/missing_node.xml
-- spec/fixtures/files/package_with_recoverable_error.zip
-- spec/fixtures/files/package_with_unrecoverable_error.zip
-- spec/fixtures/files/truncated_unrecoverable.xml
-- spec/fixtures/files/with_comments.xml
-- spec/fixtures/files/with_invalid_states.xml
-- spec/fixtures/files/with_states.xml
-- spec/fixtures/files/with_tags.xml
-- spec/lib/dradis/plugins/projects/export/v2/template_spec.rb
-- spec/lib/dradis/plugins/projects/export/v4/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/package_spec.rb
-- spec/lib/dradis/plugins/projects/upload/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/v1/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/v2/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/v4/template_spec.rb
 homepage: https://dradis.com/ce/
 licenses:
 - GPL-2
@@ -172,22 +147,4 @@ requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
 summary: Project export/upload for the Dradis Framework.
-test_files:
-- spec/fixtures/files/attachments_url.xml
-- spec/fixtures/files/invalid_byte_recoverable.xml
-- spec/fixtures/files/malformed_ids.xml
-- spec/fixtures/files/missing_node.xml
-- spec/fixtures/files/package_with_recoverable_error.zip
-- spec/fixtures/files/package_with_unrecoverable_error.zip
-- spec/fixtures/files/truncated_unrecoverable.xml
-- spec/fixtures/files/with_comments.xml
-- spec/fixtures/files/with_invalid_states.xml
-- spec/fixtures/files/with_states.xml
-- spec/fixtures/files/with_tags.xml
-- spec/lib/dradis/plugins/projects/export/v2/template_spec.rb
-- spec/lib/dradis/plugins/projects/export/v4/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/package_spec.rb
-- spec/lib/dradis/plugins/projects/upload/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/v1/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/v2/template_spec.rb
-- spec/lib/dradis/plugins/projects/upload/v4/template_spec.rb
+test_files: []

data/.github/pull_request_template.md

@@ -1,45 +0,0 @@
-Please review [CONTRIBUTING.md](https://github.com/dradis/dradis-ce/blob/develop/CONTRIBUTING.md) and remove this line.
-
-### Summary
-
-Provide a general description of the code changes in your pull
-request... were there any bugs you had fixed? If so, mention them. If
-these bugs have open GitHub issues, be sure to tag them here as well,
-to keep the conversation linked together.
-
-
-### Testing Steps
-
-Provide steps to test functionality, described in detail for someone not familiar with this part of the application / code base
-
-
-### Other Information
-
-If there's anything else that's important and relevant to your pull
-request, mention that information here. This could include
-benchmarks, or other information.
-
-Thanks for contributing to Dradis!
-
-
-### Copyright assignment
-
-Collaboration is difficult with commercial closed source but we want
-to keep as much of the OSS ethos as possible available to users
-who want to fix it themselves.
-
-In order to unambiguously own and sell Dradis Framework commercial
-products, we must have the copyright associated with the entire
-codebase. Any code you create which is merged must be owned by us.
-That's not us trying to be a jerks, that's just the way it works.
-
-You can delete this section, but the following sentence needs to
-remain in the PR's description:
-
-> I assign all rights, including copyright, to any future Dradis
-> work by myself to Security Roots.
-
-### Check List
-
-- [ ] Added a CHANGELOG entry
-- [ ] Added specs

data/.gitignore

@@ -1,12 +0,0 @@
-# Bundler config
-Gemfile.lock
-/.bundle/
-/vendor/bundle/
-
-# Combustion engine
-/spec/internal/log/*.log
-
-# Gem artifacts
-/pkg/
-
-.DS_Store

data/.ruby-version

@@ -1 +0,0 @@
-2.7.2

data/CHANGELOG.template

@@ -1,12 +0,0 @@
-[v#.#.#] ([month] [YYYY])
-  - [future tense verb] [feature]
-  - Upgraded gems:
-    - [gem]
-  - Bugs fixes:
-    - [future tense verb] [bug fix]
-    - Bug tracker items:
-      - [item]
-  - Security Fixes:
-    - High: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]
-    - Medium: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]
-    - Low: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]

data/CONTRIBUTING.md

@@ -1,3 +0,0 @@
-# Plugin contribution guidelines
-
-See the Dradis Framework's [CONTRIBUTING.md](https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md)

data/Gemfile

@@ -1,17 +0,0 @@
-source "https://rubygems.org"
-
-# Declare your gem's dependencies in dradis-burp.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
-gemspec
-
-# jquery-rails is used by the dummy application
-# gem "jquery-rails"
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use debugger
-# gem 'debugger'

data/dradis-projects.gemspec

@@ -1,29 +0,0 @@
-$:.push File.expand_path('../lib', __FILE__)
-
-require 'dradis/plugins/projects/version'
-
-# Describe your gem and declare its dependencies:
-Gem::Specification.new do |spec|
-  spec.platform = Gem::Platform::RUBY
-  spec.name = 'dradis-projects'
-  spec.version = Dradis::Plugins::Projects::VERSION::STRING
-  spec.summary = 'Project export/upload for the Dradis Framework.'
-  spec.description = 'This plugin allows you to dump the contents of the repo into a zip archive and restore the state from one of them.'
-
-  spec.license = 'GPL-2'
-
-  spec.authors = ['Daniel Martin']
-  spec.homepage = 'https://dradis.com/ce/'
-
-  spec.files = `git ls-files`.split($\)
-  spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'combustion'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec'
-
-  spec.add_dependency 'dradis-plugins', '>= 4.8.0'
-  spec.add_dependency 'rubyzip'
-end

data/spec/fixtures/files/attachments_url.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?><dradis-template version="2"><nodes><node><id>5</id><label>Uploaded files</label><parent-id/><position>0</position><properties><![CDATA[{
-}]]></properties><type-id>0</type-id><notes></notes><evidence></evidence><activities></activities></node></nodes><issues><issue><id>2</id><author>admin@securityroots.com</author><text><![CDATA[#[Title]#
-Test Issue
-
-#[Description]#
-!/pro/projects/222/nodes/5/attachments/hello.jpg!
-
-!/projects/222/nodes/5/attachments/hello.jpg!
-
-!/pro/nodes/5/attachments/hello.jpg!
-
-!/nodes/5/attachments/hello.jpg!
-
-]]></text><activities></activities><comments></comments></issue></issues><methodologies></methodologies><categories>
-<category><id>2</id><name>Issue description</name></category></categories><tags/></dradis-template>

data/spec/fixtures/files/invalid_byte_recoverable.xml

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<dradis-template version="4">
-  <categories></categories>
-  <nodes></nodes>
-  <issues>
-    <issue>
-      <id>1</id>
-      <author>tester</author>
-      <text><![CDATA[#[Title]#
-Sample Issue�
-
-#[Description]#
-This is a valid issue used to confirm recoverable XML errors don't block import.
-]]></text>
-    </issue>
-  </issues>
-  <methodologies></methodologies>
-  <tags></tags>
-</dradis-template>

data/spec/fixtures/files/malformed_ids.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<dradis-template version="1">
-  <nodes>
-    <node>
-      <id>../../../../../../tmp</id>
-      <label>Node 1</label>
-      <parent-id/>
-      <position>0</position>
-      <properties><![CDATA[{
-}]]></properties>
-      <type-id>1</type-id>
-    </node>
-  </nodes>
-</dradis-template>

data/spec/fixtures/files/missing_node.xml

@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<dradis-template version="2">
-<nodes><node><id>5</id><label>Uploaded files</label><parent-id/><position>0</position><properties><![CDATA[{}]]></properties><type-id>0</type-id><notes></notes><evidence></evidence><activities></activities></node></nodes>
-<issues><issue><id>2</id><author>admin@securityroots.com</author><text><![CDATA[#[Title]#
-Test Issue
-
-#[Description]#
-!/pro/projects/222/nodes/12345/attachments/hello.jpg!
-
-  ]]></text><activities></activities><comments></comments></issue></issues>
-</dradis-template>

data/spec/fixtures/files/truncated_unrecoverable.xml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<dradis-template version="4">
-  <categories></categories>
-  <nodes>
-    <node>
-      <id>1</id>
-      <label>Node A</label>
-      <type-id>0</type-id>
-      <parent-id></parent-id>

data/spec/fixtures/files/with_comments.xml

@@ -1,110 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<dradis-template version="2">
-  <nodes>
-    <node>
-      <id>3</id>
-      <label>Node 1</label>
-      <parent-id/>
-      <position>0</position>
-      <properties><![CDATA[{
-}]]></properties>
-      <type-id>1</type-id>
-      <notes>
-        <note>
-          <id>2</id>
-          <author>xavi</author>
-          <category-id>2</category-id>
-          <text><![CDATA[#[Title]#
-Note 1
-
-#[Description]#
-
-]]></text>
-          <activities>
-            <activity>
-              <action>create</action>
-              <user_email>xavi</user_email>
-              <created_at>1538467955</created_at>
-            </activity>
-          </activities>
-          <comments>
-            <comment>
-              <content><![CDATA[A comment on a note]]></content>
-              <author>xavi</author>
-              <created_at>1538467968</created_at>
-            </comment>
-          </comments>
-        </note>
-      </notes>
-      <evidence>
-        <evidence>
-          <id>386</id>
-          <author>xavi</author>
-          <issue-id>586</issue-id>
-          <content><![CDATA[#[Location]#
-A
-]]></content>
-          <activities>
-            <activity>
-              <action>create</action>
-              <user_email>xavi</user_email>
-              <created_at>1538549260</created_at>
-            </activity>
-          </activities>
-          <comments>
-            <comment>
-              <content><![CDATA[A comment on an evidence]]></content>
-              <author>xavi</author>
-              <created_at>1538549286</created_at>
-            </comment>
-          </comments>
-        </evidence>
-      </evidence>
-      <activities>
-        <activity>
-          <action>create</action>
-          <user_email>xavi</user_email>
-          <created_at>1538467945</created_at>
-        </activity>
-      </activities>
-    </node>
-  </nodes>
-  <issues>
-    <issue>
-      <id>586</id>
-      <author>xavi</author>
-      <text><![CDATA[#[Title]#
-Issue 1
-
-#[Description]#
-
-]]></text>
-      <activities>
-        <activity>
-          <action>create</action>
-          <user_email>xavi</user_email>
-          <created_at>1538467938</created_at>
-        </activity>
-      </activities>
-      <comments>
-        <comment>
-          <content><![CDATA[A comment on an issue]]></content>
-          <author>xavi</author>
-          <created_at>1538467997</created_at>
-        </comment>
-      </comments>
-    </issue>
-  </issues>
-  <methodologies/>
-  <categories>
-    <category>
-      <id>1</id>
-      <name>Issue description</name>
-    </category>
-    <category>
-      <id>2</id>
-      <name>Default category</name>
-    </category>
-  </categories>
-  <tags/>
-</dradis-template>