defmastership 1.0.1 → 1.0.6

data/features/export.feature

@@ -12,16 +12,86 @@ Feature: The extract command
     Second line.
     --
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value
+    Type,Reference,Value,sha256
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line."
+    Second line.",b86dcbde
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
 
+  Scenario: Extract one definition with WRONG explicit checksum to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001(babe1234)]
+    def one
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,sha256,Wrong explicit checksum
+    requirement,TOTO-0001,def one,d27cb5c3,babe1234
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract two definitions with one WRONG explicit checksum to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001(d27cb5c3)]
+    def one
+
+    [define, requirement, TOTO-0002(babe1234)]
+    def two
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,sha256,Wrong explicit checksum
+    requirement,TOTO-0001,def one,d27cb5c3,\"\"
+    requirement,TOTO-0002,def two,b80e1be5,babe1234
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract one definition with explicit checksum to CSV 
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001(b86dcbde)]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,sha256
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",b86dcbde
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Extract to CSV with alternative CSV separator
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export --separator=';' toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type;Reference;Value;sha256
+    requirement;TOTO-0001;"Exemple of multiline requirement.
+    Second line.";b86dcbde
+    """
+
   Scenario: Extract one definition with variable to CSV 
     Given a file named "toto.adoc" with:
     """
@@ -34,13 +104,13 @@ Feature: The extract command
     Third line with {not_defined_variable}.
     --
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value
+    Type,Reference,Value,sha256
     requirement,TOTO-0001,"Exemple of multiline requirement with variable: Variable content.
     Variable content : Variable content Toto.
-    Third line with {not_defined_variable}."
+    Third line with {not_defined_variable}.",3bf370ed
     """
     And the stdout should not contain anything
     And the stderr should not contain anything
@@ -62,13 +132,14 @@ Feature: The extract command
     Second line.
     --
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value
+    Type,Reference,Value,sha256
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line."
-    something_else,TOTO-0003,"only one paragraphe.\nwith two sentences."
+    Second line.",b86dcbde
+    something_else,TOTO-0003,"only one paragraphe.
+    with two sentences.",4761e172
     """
     And the file "toto.csv" should not contain:
     """
@@ -90,7 +161,7 @@ Feature: The extract command
     only one line
     ....
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should not contain:
     """
     something_else
@@ -111,7 +182,7 @@ Feature: The extract command
     only one line
     ////
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should not contain:
     """
     something_else
@@ -134,7 +205,7 @@ Feature: The extract command
     ////
     [define, something_else, TOTO-0003]
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
     something_else
@@ -151,12 +222,12 @@ Feature: The extract command
     Second line.
     --
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,Labels
+    Type,Reference,Value,sha256,Labels
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.","label1
+    Second line.",b86dcbde,"label1
     label2"
     """
     And the stdout should not contain anything
@@ -174,12 +245,12 @@ Feature: The extract command
     --
     defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,Participate to: ./the_other_document.html
+    Type,Reference,Value,sha256,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.","SYSTEM-0012
+    Second line.",b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
     And the stdout should not contain anything
@@ -197,12 +268,12 @@ Feature: The extract command
     --
     defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,Participate to:
+    Type,Reference,Value,sha256,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.","SYSTEM-0012
+    Second line.",b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
     And the stdout should not contain anything
@@ -219,14 +290,14 @@ Feature: The extract command
     --
     defs:eref[implements, [SYSTEM-0012, SYSTEM-0014]]
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the stdout should not contain anything
     And the stderr should not contain anything
     And the file "toto.csv" should contain:
     """
-    Type,Reference,Value,Participate to:
+    Type,Reference,Value,sha256,Participate to:
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line.","SYSTEM-0012
+    Second line.",b86dcbde,"SYSTEM-0012
     SYSTEM-0014"
     """
 
@@ -240,12 +311,12 @@ Feature: The extract command
     --
     please see defs:iref[TOTO-0002]
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,Internal links
+    Type,Reference,Value,sha256,Internal links
     requirement,TOTO-0001,"Exemple of multiline requirement.
-    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].","TOTO-0001
+    Second line: defs:iref[TOTO-0001], defs:iref[TOTO-0123].",059b7188,"TOTO-0001
     TOTO-0123
     TOTO-0002"
     """
@@ -264,12 +335,12 @@ Feature: The extract command
     defs:attribute[verifiedby, Beautiful Test]
     defs:attribute[criticity, Very cool]
     """
-    When I run `defmastership export toto.adoc`
+    When I successfully run `defmastership export toto.adoc`
     And the stdout should not contain anything
     Then the file "toto.csv" should contain:
     """
-    Type,Reference,Value,Verified by:,Criticity:
-    requirement,TOTO-0001,One single line.,Beautiful Test,Very cool
+    Type,Reference,Value,sha256,Verified by:,Criticity:
+    requirement,TOTO-0001,One single line.,554b0ff5,Beautiful Test,Very cool
     """
     And the stdout should not contain anything
     And the stderr should not contain anything

data/features/modify.feature

@@ -0,0 +1,143 @@
+Feature: The modify command
+  As a Responsible of definitions for a given document
+  In order to manage to applu predefined modifications
+  I want defmastership to apply automatic modifications
+
+  Scenario: Change one modifier
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    """
+    When I successfully run `defmastership modify --modifications temp-references thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "modifications.yml" should contain:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    """
+
+  Scenario: Make modifications with yaml file parameter 
+    Given a file named "pouet.yml" with:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    """
+    When I successfully run `defmastership modify --modifications-file=pouet.yml --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "pouet.yml" should contain:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    """
+
+  Scenario: Generate a table with changes
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    [define, requirement, TOTO-TEMP-XXX2]
+    """
+    When I successfully run `defmastership modify --modifications temp-references --changes-summary=changes.csv thedoc.adoc`
+    Then the stderr should not contain anything
+    And the stdout should not contain anything
+    And the file "changes.csv" should contain:
+    """
+    Modifier,Was,Becomes
+    temp-references,TOTO-TEMP-XXX1,TOTO-0123
+    temp-references,TOTO-TEMP-XXX2,TOTO-0124
+    """
+
+  Scenario: Apply two modifcations
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    :tata_or_titi:
+      :type: change_ref
+      :config:
+        :from_regexp: "(?<tata_or_titi>TATA|TITI)-TEMP-[X\\d]{4}"
+        :to_template: "%<tata_or_titi>s-%<next_ref>07d"
+        :next_ref: 432
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    [define, requirement, TITI-TEMP-XXX2]
+    """
+    When I successfully run `defmastership modify --modifications temp-references,tata_or_titi --changes-summary=changes.csv thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "modifications.yml" should contain:
+    """
+    ---
+    :temp-references:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    :tata_or_titi:
+      :type: change_ref
+      :config:
+        :from_regexp: "(?<tata_or_titi>TATA|TITI)-TEMP-[X\\d]{4}"
+        :to_template: "%<tata_or_titi>s-%<next_ref>07d"
+        :next_ref: 433
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123]
+    [define, requirement, TITI-0000432]
+    """

data/features/rename_included_files.feature

@@ -0,0 +1,121 @@
+
+Feature: The rename_included_files command
+  As a Responsible of definitions for a given document.
+  In order to easy traceability with included files,
+  I want defmastership to change filename of included files to reflect
+  reference.
+
+  Scenario: do NOT change the filename of a file NOT included in a definition
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    include::any_path/one_file.png[]
+    """
+    And a directory named "any_path"
+    And an empty file named "any_path/one_file.png"
+    When I successfully run `defmastership modify --modifications rename_included_png thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    include::any_path/one_file.png[]
+    """
+    And the file "any_path/one_file.png" should exist
+
+  Scenario: change the filename of a file included in a definition
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::any_path/one_file.png[]
+    """
+    And a directory named "any_path"
+    And an empty file named "any_path/one_file.png"
+    When I successfully run `defmastership modify --modifications rename_included_png thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::any_path/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And the file "any_path/one_file.png" should not exist
+    And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
+
+  Scenario: change the filename with variable in path
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    :any: one
+    :path: two
+    [define, requirement, TOTO-WHATEVER-123]
+    include::{any}_{path}/one_file.png[]
+    """
+    And a directory named "one_two"
+    And an empty file named "one_two/one_file.png"
+    When I successfully run `defmastership modify --modifications rename_included_png thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    :any: one
+    :path: two
+    [define, requirement, TOTO-WHATEVER-123]
+    include::{any}_{path}/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And the file "one_two/one_file.png" should not exist
+    And the file "one_two/TOTO-WHATEVER-123_one_file.png" should exist
+
+  Scenario: DO NOT change the filename again and again
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :rename_included_png:
+      :type: rename_included_files
+      :config:
+        :from_regexp: (?<origin>.*\.png)
+        :cancel_if_match: TOTO-WHATEVER
+        :to_template: "%<reference>s_%<origin>s"
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::any_path/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And a directory named "any_path"
+    And an empty file named "any_path/TOTO-WHATEVER-123_one_file.png"
+    When I successfully run `defmastership modify --modifications rename_included_png thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-WHATEVER-123]
+    include::any_path/TOTO-WHATEVER-123_one_file.png[]
+    """
+    And the file "any_path/one_file.png" should not exist
+    And the file "any_path/TOTO-WHATEVER-123_one_file.png" should exist
+