dradis-projects 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0256537152511bdd57bd8bda059eecd5adfaf3d4
-  data.tar.gz: a456a38a9168d70a77266162a18844308314c479
+  metadata.gz: 594be647b3882ca2d8e0c56befaee84b41984ca7
+  data.tar.gz: 6eddd5014d88cf6ba493b0dfffc0622dd8fd96dd
 SHA512:
-  metadata.gz: 603efc920654a2a403a74094f036f742a0b02250e4fc030f10a4d25acdcce08b138b510fca6bfc30a82071a87f308990969e7cdf3a659cd0ed66bd1a09848432
-  data.tar.gz: 460caa7831aa233b2ada3e90333c1f2e4e9bdcaf7ee61b6ba323bf8b226722b1a4daf44062cdc5a5b6d0a477cebd9ffe156151cff381cdad0a28d79395a3324b
+  metadata.gz: d7df7bdbe490f458595460ea82853c1a1bc8f667672a3f684f98bd3c300b5f1a856f6cd82fea60da2e076d02e46a2fd68773417866f4bec9867c60175f88e688
+  data.tar.gz: 8127ca13c25cf5c42946f627103701e614031704d37cb348ff8c4f7e209276daac71b2f64c7db018c2ab1ffd93c92073ab1b12a9d39bf9a666b5ee68a89a04b5

data/CHANGELOG.md

@@ -1,10 +1,14 @@
+## Dradis Framework 3.11 (November, 2018) ##
+
+*  Note and evidence comments in export/import
+
 ## Dradis Framework 3.10 (August, 2018) ##
 
 *   Use project scopes
 
 *   Check project existence for default user id
 
-*   Comments export import
+*   Issue comments in export/import
 
 *   Replace Node methods that are now Project methods
 

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

@@ -33,6 +33,9 @@ module Dradis::Plugins::Projects::Export::V1
       end
     end
 
+    # No-op here, overwritten in V2
+    def build_comments_for(builder, commentable); end
+
     def build_evidence_for_node(builder, node)
       builder.evidence do |evidences_builder|
         node.evidence.each do |evidence|
@@ -44,6 +47,7 @@ module Dradis::Plugins::Projects::Export::V1
               evidence_builder.cdata!(evidence.content)
             end
             build_activities_for(evidence_builder, evidence)
+            build_comments_for(evidence_builder, evidence)
           end
         end
       end
@@ -61,6 +65,7 @@ module Dradis::Plugins::Projects::Export::V1
               issue_builder.cdata!(issue.text)
             end
             build_activities_for(issue_builder, issue)
+            build_comments_for(issue_builder, issue)
           end
         end
       end
@@ -117,11 +122,13 @@ module Dradis::Plugins::Projects::Export::V1
               note_builder.cdata!(note.text)
             end
             build_activities_for(note_builder, note)
+            build_comments_for(note_builder, note)
           end
         end
       end
     end
 
+    # No-op here, overwritten in PRO
     def build_report_content(builder); end
 
     def build_tags(builder)

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

@@ -17,24 +17,5 @@ module Dradis::Plugins::Projects::Export::V2
         end
       end
     end
-
-    def build_issues(builder)
-      @issues = Issue.where(node_id: project.issue_library).includes(:activities)
-
-      builder.issues do |issues_builder|
-        @issues.each do |issue|
-          issues_builder.issue do |issue_builder|
-            issue_builder.id(issue.id)
-            issue_builder.author(issue.author)
-            issue_builder.text do
-              issue_builder.cdata!(issue.text)
-            end
-            build_activities_for(issue_builder, issue)
-            build_comments_for(issue_builder, issue)
-          end
-        end
-      end
-    end
-
   end
 end

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

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

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

@@ -28,8 +28,9 @@ module Dradis::Plugins::Projects::Upload::V1
           evidence: [],
 
           # likewise we also need to hold on to the XML about evidence activities
-          # until after the evidence has been saved
+          # and comments until after the evidence has been saved
           evidence_activity: [],
+          evidence_comments: [],
 
           # all children nodes, we will need to find the ID of their new parents.
           orphan_nodes: []
@@ -38,6 +39,11 @@ module Dradis::Plugins::Projects::Upload::V1
 
       private
 
+      # No-op here, overwritten in V2
+      def create_comments(commentable, xml_comments)
+        true
+      end
+
       def create_activities(trackable, xml_trackable)
         xml_trackable.xpath('activities/activity').each do |xml_activity|
           # if 'validate_and_save(activity)' returns false, it needs
@@ -71,6 +77,8 @@ module Dradis::Plugins::Projects::Upload::V1
 
         return false unless create_activities(issue, xml_issue)
 
+        return false unless create_comments(issue, xml_issue.xpath('comments/comment'))
+
         true
       end
 
@@ -117,6 +125,9 @@ module Dradis::Plugins::Projects::Upload::V1
           pending_changes[:evidence_activity][i].each do |xml_activity|
             raise "Couldn't create activity for Evidence ##{evidence.id}" unless create_activity(evidence, xml_activity)
           end
+
+          xml_comments = pending_changes[:evidence_comments][i]
+          raise "Couldn't create comments for Evidence ##{evidence.id}" unless create_comments(evidence, xml_comments)
         end
       end
 
@@ -299,6 +310,7 @@ module Dradis::Plugins::Projects::Upload::V1
 
             pending_changes[:evidence]          << evidence
             pending_changes[:evidence_activity] << xml_evidence.xpath('activities/activity')
+            pending_changes[:evidence_comments] << xml_evidence.xpath('comments/comment')
 
             logger.info { "\tNew evidence added." }
           end
@@ -333,6 +345,7 @@ module Dradis::Plugins::Projects::Upload::V1
             end
 
             raise "Couldn't create activities for Note ##{note.id}" unless create_activities(note, xml_note)
+            raise "Couldn't create comments for Note ##{note.id}" unless create_comments(note, xml_note.xpath('comments/comment'))
 
             logger.info { "\tNew note added." }
           end

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

@@ -25,13 +25,6 @@ module Dradis::Plugins::Projects::Upload::V2
           return false unless validate_and_save(comment)
         end
       end
-
-      def create_issue(issue, xml_issue)
-        return false unless super
-        return false unless create_comments(issue, xml_issue.xpath('comments/comment'))
-
-        true
-      end
     end
   end
 end

data/spec/fixtures/files/with_comments.xml

@@ -0,0 +1,110 @@
+<?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>1</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>

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

@@ -0,0 +1,52 @@
+require 'rails_helper'
+
+describe Dradis::Plugins::Projects::Export::V2::Template do
+  let(:project) { create(:project) }
+  let(:user) { create(:user) }
+  let(:export) do
+    described_class.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
+
+    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, text: '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
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'rails_helper'
+
+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 }
+  let(:file_path) do
+    File.join(
+      File.dirname(__FILE__),
+      '../../../../../../',
+      'fixtures',
+      'files',
+      'with_comments.xml'
+    )
+  end
+
+  context 'uploading a template with comments' do
+    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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-projects
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,10 @@ files:
 - lib/dradis/plugins/projects/version.rb
 - lib/tasks/thorfile.rb
 - spec/fixtures/files/attachments_url.xml
+- spec/fixtures/files/with_comments.xml
+- spec/lib/dradis/plugins/projects/export/v2/template_spec.rb
 - spec/lib/dradis/plugins/projects/upload/v1/template_spec.rb
+- spec/lib/dradis/plugins/projects/upload/v2/template_spec.rb
 homepage: http://dradisframework.org
 licenses:
 - GPL-2
@@ -156,4 +159,7 @@ specification_version: 4
 summary: Project export/upload for the Dradis Framework.
 test_files:
 - spec/fixtures/files/attachments_url.xml
+- spec/fixtures/files/with_comments.xml
+- spec/lib/dradis/plugins/projects/export/v2/template_spec.rb
 - spec/lib/dradis/plugins/projects/upload/v1/template_spec.rb
+- spec/lib/dradis/plugins/projects/upload/v2/template_spec.rb