dradis-projects 4.7.0 → 4.8.0

data/spec/fixtures/files/with_invalid_states.xml

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<dradis-template version="4">
+  <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>
+      <state>fakestate</state>
+      <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>

data/spec/fixtures/files/with_states.xml

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<dradis-template version="4">
+  <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>
+      <state>ready_for_review</state>
+      <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>

data/spec/lib/dradis/plugins/projects/export/v2/template_spec.rb

@@ -1,6 +1,14 @@
+# DEPRECATED - this class is v2 of the Template Importer and shouldn't be updated.
+# V4 released on Apr 2022
+# V2 can be removed on Apr 2024
+#
+# We're duplicating this file for v4, and even though the code lives in two
+# places now, this file isn't expected to evolve and is now frozen to V2
+# behavior.
+
 require 'rails_helper'
 
-describe Dradis::Plugins::Projects::Export::V2::Template do
+describe 'Dradis::Plugins::Projects::Export::V2::Template' do
   let(:project) { create(:project) }
   let(:user) { create(:user) }
   let(:export) do

data/spec/lib/dradis/plugins/projects/export/v4/template_spec.rb

@@ -0,0 +1,84 @@
+# Run the spec in CE/Pro context with:
+# rspec <relative path to dradis-projects>/spec/lib/dradis/plugins/projects/export/v4/template_spec.rb
+
+require 'rails_helper'
+
+describe 'Dradis::Plugins::Projects::Export::V4::Template' do
+  let(:project) { create(:project) }
+  let(:user) { create(:user) }
+  let(:exporter) { 'Dradis::Plugins::Projects::Export::V4::Template' }
+  let(:export) do
+    exporter.constantize.new(
+      default_user_id: user.id,
+      plugin: Dradis::Plugins::Projects,
+      project_id: project.id
+    ).export
+  end
+
+  context 'exporting a project' do
+    before do
+      @node = create(:node, project: project)
+      @issue = create(:issue, text: 'Issue 1', node: project.issue_library)
+    end
+
+    describe 'comments' do
+      context 'with comments in an issue' do
+        before do
+          create(:comment, content: 'A comment on an issue', commentable: @issue)
+        end
+
+        it 'exports comments in the issue' do
+          expect(export).to include('A comment on an issue')
+        end
+      end
+
+      context 'with comments in a note' do
+        before do
+          note = create(:note, text: 'Note 1', node: @node)
+          create(:comment, content: 'A comment on a note', commentable: note)
+        end
+
+        it 'exports comments in the note' do
+          expect(export).to include('A comment on a note')
+        end
+      end
+
+      context 'with comments in an evidence' do
+        before do
+          evidence = create(:evidence, content: 'Test evidence', node: @node, issue: @issue)
+          create(:comment, content: 'A comment on an evidence', commentable: evidence)
+        end
+
+        it 'exports comments in the evidence' do
+          expect(export).to include('A comment on an evidence')
+        end
+      end
+
+      context 'with comments with a deleted author' do
+        before do
+          note = create(:note, text: 'Note 1', node: @node)
+          comment = create(:comment, content: 'Deleted user', commentable: note)
+          comment.update_attribute :user, nil
+        end
+
+        it 'exports the comment without errors' do
+          expect(export).to include('Deleted user')
+        end
+      end
+    end
+
+    describe 'states' do
+      before do
+        Issue.states.each do |state|
+          create(:issue, text: 'Issue 1', node: project.issue_library, state: state[0])
+        end
+      end
+
+      it 'export issues with states' do
+        Issue.states.each do |state|
+          expect(export).to include("<state>#{state[0]}</state>")
+        end
+      end
+    end
+  end
+end

data/spec/lib/dradis/plugins/projects/upload/v1/template_spec.rb

@@ -1,3 +1,11 @@
+# DEPRECATED - this class is v1 of the Template Importer and shouldn't be updated.
+# V4 released on Apr 2022
+# V1 can be removed on Apr 2024
+#
+# We're duplicating this file for v4, and even though the code lives in two
+# places now, this file isn't expected to evolve and is now frozen to V1
+# behavior.
+
 # frozen_string_literal: true
 
 require 'rails_helper'

data/spec/lib/dradis/plugins/projects/upload/v2/template_spec.rb

@@ -1,6 +1,14 @@
+# DEPRECATED - this class is v2 of the Template Importer and shouldn't be updated.
+# V4 released on Apr 2022
+# V2 can be removed on Apr 2024
+#
+# We're duplicating this file for v4, and even though the code lives in two
+# places now, this file isn't expected to evolve and is now frozen to V2
+# behavior.
+
 require 'rails_helper'
 
-describe Dradis::Plugins::Projects::Upload::V2::Template::Importer do
+describe 'Dradis::Plugins::Projects::Upload::V2::Template::Importer' do
   let(:project) { create(:project) }
   let(:user) { create(:user) }
   let(:importer_class) { Dradis::Plugins::Projects::Upload::Template }

data/spec/lib/dradis/plugins/projects/upload/v4/template_spec.rb

@@ -0,0 +1,168 @@
+# Run the spec in CE/Pro context with:
+# rspec <relative path to dradis-projects>/spec/lib/dradis/plugins/projects/upload/v4/template_spec.rb
+
+require 'rails_helper'
+
+describe 'Dradis::Plugins::Projects::Upload::V4::Template::Importer' do
+  let(:project) { create(:project) }
+  let(:user) { create(:user) }
+  let(:importer_class) { Dradis::Plugins::Projects::Upload::Template }
+
+  context 'uploading a template with attachments url' do
+    let(:file_path) do
+      File.join(File.dirname(__FILE__), '../../../../../../', 'fixtures', 'files', 'attachments_url.xml')
+    end
+
+    it 'converts the urls' do
+      importer = importer_class::Importer.new(
+        default_user_id: user.id,
+        plugin: importer_class,
+        project_id: project.id
+      )
+
+      importer.import(file: file_path)
+
+      p_id = project.id
+      n_id = project.plugin_uploads_node.id
+
+      expect(project.issues.first.text).to include(
+        "!/pro/projects/#{p_id}/nodes/#{n_id}/attachments/hello.jpg!\n\n" +
+        "!/projects/#{p_id}/nodes/#{n_id}/attachments/hello.jpg!\n\n" +
+        "!/pro/projects/#{p_id}/nodes/#{n_id}/attachments/hello.jpg!\n\n" +
+        "!/projects/#{p_id}/nodes/#{n_id}/attachments/hello.jpg!"
+      )
+    end
+  end
+
+  context 'uploading a template malformed paths as ids' do
+    let(:file_path) do
+      File.join(File.dirname(__FILE__), '../../../../../../', 'fixtures', 'files', 'malformed_ids.xml')
+    end
+
+    it 'returns false' do
+      importer = importer_class::Importer.new(
+        default_user_id: user.id,
+        plugin: importer_class,
+        project_id: project.id
+      )
+
+      expect(importer.import(file: file_path)).to be false
+    end
+  end
+
+  context 'uploading a template with attachment but missing node' do
+    let(:file_path) do
+      File.join(File.dirname(__FILE__), '../../../../../../', 'fixtures', 'files', 'missing_node.xml')
+    end
+
+    it 'does not modify the attachment' do
+      logger = double('logger')
+      allow(logger).to receive_messages(debug: nil, error: nil, fatal: nil, info: nil)
+      expect(logger).to receive(:error).once
+
+      importer = importer_class::Importer.new(
+        default_user_id: user.id,
+        logger: logger,
+        plugin: importer_class,
+        project_id: project.id
+      )
+
+      importer.import(file: file_path)
+
+      expect(project.issues.first.text).to include(
+        "!/pro/projects/222/nodes/12345/attachments/hello.jpg!"
+      )
+    end
+  end
+
+  context 'uploading a template with comments' do
+    let(:file_path) do
+      File.join(
+        File.dirname(__FILE__),
+        '../../../../../../',
+        'fixtures',
+        'files',
+        'with_comments.xml'
+      )
+    end
+
+    before do
+      importer = importer_class::Importer.new(
+        default_user_id: user.id,
+        plugin: importer_class,
+        project_id: project.id
+      )
+
+      importer.import(file: file_path)
+    end
+
+    let(:node) { project.nodes.find_by(label: 'Node 1') }
+
+    it 'imports comments in issues' do
+      issue = project.issues.first
+      expect(issue.comments.first.content).to include('A comment on an issue')
+    end
+
+    it 'imports comments in notes' do
+      note = node.notes.first
+      expect(note.comments.first.content).to include('A comment on a note')
+    end
+
+    it 'imports comments in evidence' do
+      evidence = node.evidence.first
+      expect(evidence.comments.first.content).to include('A comment on an evidence')
+    end
+
+    it 'imports comments without user' do
+      issue = project.issues.first
+      note = node.notes.first
+      evidence = node.evidence.first
+
+      aggregate_failures do
+        expect(issue.comments.first.user).to be_nil
+        expect(note.comments.first.user).to be_nil
+        expect(evidence.comments.first.user).to be_nil
+      end
+    end
+  end
+
+
+  describe 'states' do
+    let(:dir) do
+      File.join(File.dirname(__FILE__), '../../../../../../', 'fixtures', 'files')
+    end
+
+    before do
+      @importer = importer_class::Importer.new(
+        default_user_id: user.id,
+        plugin: importer_class,
+        project_id: project.id
+      )
+    end
+
+    context 'uploading a template without states' do
+      it 'imports issues with the published state' do
+        @importer.import(file: File.join(dir, 'with_comments.xml'))
+        issue = project.issues.first
+        expect(issue.state).to eq('published')
+      end
+    end
+
+    context 'uploading a template with states' do
+      context 'valid states' do
+        it 'imports issues with states from the template' do
+          @importer.import(file: File.join(dir, 'with_states.xml'))
+          issue = project.issues.first
+          expect(issue.state).to eq('ready_for_review')
+        end
+      end
+
+      context 'invalid states' do
+        it 'does not import the issue' do
+          @importer.import(file: File.join(dir, 'with_invalid_states.xml'))
+          expect(project.issues.count).to eq(0)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-projects
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: dradis-plugins
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -125,21 +125,27 @@ files:
 - lib/dradis/plugins/projects/export/v1/template.rb
 - lib/dradis/plugins/projects/export/v2/template.rb
 - lib/dradis/plugins/projects/export/v3/template.rb
+- lib/dradis/plugins/projects/export/v4/template.rb
 - lib/dradis/plugins/projects/gem_version.rb
 - lib/dradis/plugins/projects/upload/package.rb
 - lib/dradis/plugins/projects/upload/template.rb
 - lib/dradis/plugins/projects/upload/v1/template.rb
 - lib/dradis/plugins/projects/upload/v2/template.rb
 - lib/dradis/plugins/projects/upload/v3/template.rb
+- 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/malformed_ids.xml
 - spec/fixtures/files/missing_node.xml
 - spec/fixtures/files/with_comments.xml
+- spec/fixtures/files/with_invalid_states.xml
+- spec/fixtures/files/with_states.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/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: http://dradisframework.org
 licenses:
 - GPL-2
@@ -168,6 +174,10 @@ test_files:
 - spec/fixtures/files/malformed_ids.xml
 - spec/fixtures/files/missing_node.xml
 - spec/fixtures/files/with_comments.xml
+- spec/fixtures/files/with_invalid_states.xml
+- spec/fixtures/files/with_states.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/v1/template_spec.rb
 - spec/lib/dradis/plugins/projects/upload/v2/template_spec.rb
+- spec/lib/dradis/plugins/projects/upload/v4/template_spec.rb