defmastership 1.3.2 → 1.3.3

data/features/export.feature

@@ -1,9 +1,9 @@
-Feature: The extract command
+Feature: The export command
   As a Responsible of definitions
   In order to make statistics on definitions
-  I want defmastership to extract definitions from asciidoctor documents
+  I want defmastership to export definitions from asciidoctor documents
 
-  Scenario: Extract one definition to CSV 
+  Scenario: Export one definition to CSV
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -21,7 +21,31 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract to CSV with alternative CSV separator
+  Scenario: Export more adoc documents
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Requirement TOTO-0001
+    --
+    """
+    And a file named "tutu.adoc" with:
+    """
+    [define, requirement, TUTU-1000]
+    --
+    Requirement TUTU-1000
+    --
+    """
+    When I successfully run `defmastership export --output-file my_export.csv toto.adoc tutu.adoc`
+    Then the file "my_export.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,Requirement TOTO-0001,~5524684e
+    requirement,TUTU-1000,Requirement TUTU-1000,~2f52cb8b
+    """
+    And the stdout should not contain anything
+
+  Scenario: Export to CSV with alternative CSV separator
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -38,7 +62,7 @@ Feature: The extract command
     Second line.";~b86dcbde
     """
 
-  Scenario: Extract one definition with variable to CSV 
+  Scenario: Export one definition with variable to CSV
     Given a file named "toto.adoc" with:
     """
     :my_variable-with-dash: Variable content
@@ -61,7 +85,7 @@ Feature: The extract command
     And the stdout should not contain anything
 
 
-  Scenario: Extract some definitions to CSV 
+  Scenario: Export some definitions to CSV
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -152,7 +176,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Handle mixes comment and literal blocks 
+  Scenario: Handle mixes comment and literal blocks
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -174,7 +198,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract definition with summary
+  Scenario: Export definition with summary
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001, A nice summary]
@@ -192,7 +216,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract definition with summary with variable
+  Scenario: Export definition with summary with variable
     Given a file named "toto.adoc" with:
     """
     :a_variable: summary
@@ -211,7 +235,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract definition with summary including comma
+  Scenario: Export definition with summary including comma
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001, " A nice, summary " ]
@@ -229,7 +253,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract definition with labels 
+  Scenario: Export definition with labels
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001, [label1, label2]]
@@ -248,7 +272,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with external ref to CSV
+  Scenario: Export one definition with external ref to CSV
     Given a file named "toto.adoc" with:
     """
     :eref-implements-prefix: Participate to:
@@ -270,7 +294,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with external ref (with version and checksum) to CSV
+  Scenario: Export one definition with external ref (with version and checksum) to CSV
     Given a file named "toto.adoc" with:
     """
     :eref-implements-prefix: Participate to:
@@ -293,7 +317,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with missing external ref to CSV
+  Scenario: Export one definition with missing external ref to CSV
     Given a file named "toto.adoc" with:
     """
     :eref-implements-prefix: Participate to:
@@ -313,7 +337,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with external ref without url to CSV 
+  Scenario: Export one definition with external ref without url to CSV
     Given a file named "toto.adoc" with:
     """
     :eref-implements-prefix: Participate to:
@@ -335,7 +359,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with external ref to CSV without URL
+  Scenario: Export one definition with external ref to CSV without URL
     Given a file named "toto.adoc" with:
     """
     :eref-implements-prefix: Participate to:
@@ -356,7 +380,7 @@ Feature: The extract command
     SYSTEM-0014"
     """
 
-  Scenario: Extract one definition with internal ref to CSV 
+  Scenario: Export one definition with internal ref to CSV
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -377,7 +401,28 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with attributes to CSV 
+  Scenario: Export one definition with internal ref with version and checksum to CSV
+    Given a file named "toto.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of multiline requirement.
+    Second line: defs:iref[TOTO-0001(a)], defs:iref[TOTO-0123(~12345678)].
+    --
+    please see defs:iref[TOTO-0002(z~12345678)]
+    """
+    When I successfully run `defmastership export toto.adoc`
+    Then the file "toto.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Internal links
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line: defs:iref[TOTO-0001(a)], defs:iref[TOTO-0123(~12345678)].",~f5f2fbd5,"TOTO-0001(a)
+    TOTO-0123(~12345678)
+    TOTO-0002(z~12345678)"
+    """
+    And the stdout should not contain anything
+
+  Scenario: Export one definition with attributes to CSV
     Given a file named "toto.adoc" with:
     """
     :attr-verifiedby-prefix: Verified by:
@@ -398,7 +443,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with missing attributes to CSV
+  Scenario: Export one definition with missing attributes to CSV
     Given a file named "toto.adoc" with:
     """
     :attr-verifiedby-prefix: Verified by:
@@ -418,7 +463,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with example in it
+  Scenario: Export one definition with example in it
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -442,7 +487,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with single line comment in it
+  Scenario: Export one definition with single line comment in it
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]
@@ -458,7 +503,7 @@ Feature: The extract command
     """
     And the stdout should not contain anything
 
-  Scenario: Extract one definition with multi line comment or literal in it
+  Scenario: Export one definition with multi line comment or literal in it
     Given a file named "toto.adoc" with:
     """
     [define, requirement, TOTO-0001]

data/features/external_ref_checksum.feature

@@ -0,0 +1,169 @@
+Feature: internal ref checksum
+  As a Responsible of definitions for a given document
+  In order to detect impacts of the modifications of definitions
+  I want defmastership update checksum in definitions internal references
+
+  Scenario Outline: Update one internal ref (<comment>)
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_checksum:
+      :type: update_eref_checksum
+      :config:
+        :eref_type: implements
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1<before>]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1<after>]]
+    """
+
+    Examples:
+      | before       | after        | comment                       |
+      |              | (~244eed18)  | No initial checksum           |
+      | (~abcd1234)  | (~244eed18)  | With initial checksum         |
+      | (a)          | (a~244eed18) | With a version                |
+      | (a~abcd1234) | (a~244eed18) | With a version and a checksum |
+
+  Scenario: Update more external refs with multiple reference doc
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_checksum:
+      :type: update_eref_checksum
+      :config:
+        :eref_type: implements
+        :ref_document:
+        - reference1.adoc
+        - reference2.adoc
+    """
+    And a file named "reference1.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "reference2.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX2]
+    --
+    Another requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1, TOTO-TEMP-XXX2]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(~244eed18), TOTO-TEMP-XXX2(~a3c1c965)]]
+    """
+
+  Scenario: Not matching eref_type
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_checksum:
+      :type: update_eref_checksum
+      :config:
+        :eref_type: implements
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(~244eed18)]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    """
+
+  Scenario: No eref_type
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_checksum:
+      :type: update_eref_checksum
+      :config:
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(~244eed18)]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1(~244eed18)]]
+    """
+
+  Scenario: eref_type with a list
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_checksum:
+      :type: update_eref_checksum
+      :config:
+        :eref_type:
+        - implements
+        - pouet
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    defs:eref[pouet, [TOTO-TEMP-XXX1]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(~244eed18)]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    defs:eref[pouet, [TOTO-TEMP-XXX1(~244eed18)]]
+    """

data/features/external_ref_version.feature

@@ -0,0 +1,173 @@
+Feature: internal ref version
+  As a Responsible of definitions for a given document
+  In order to detect impacts of the modifications of definitions
+  I want defmastership update version in definitions internal references
+
+  Scenario Outline: Update one internal ref (<comment>)
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_version:
+      :type: update_eref_version
+      :config:
+        :eref_type: implements
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1<ref version>]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1<before>]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_version thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1<after>]]
+    """
+
+    Examples:
+      | ref version | before       | after        | comment                      |
+      | (z)         |              | (z)          | No initial version           |
+      | (z)         | (a)          | (z)          | With initial version         |
+      | (z)         | (~abcd1234)  | (z~abcd1234) | With a version               |
+      | (z)         | (a~abcd1234) | (z~abcd1234) | With a version and a version |
+      |             |              |              | No initial version           |
+      |             | (a)          |              | With initial version         |
+      |             | (~abcd1234)  | (~abcd1234)  | With a version               |
+      |             | (a~abcd1234) | (~abcd1234)  | With a version and a version |
+
+  Scenario: Update more external refs with multiple reference doc
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_version:
+      :type: update_eref_version
+      :config:
+        :eref_type: implements
+        :ref_document:
+        - reference1.adoc
+        - reference2.adoc
+    """
+    And a file named "reference1.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(a)]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "reference2.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX2(z)]
+    --
+    Another requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1, TOTO-TEMP-XXX2]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_version thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(a), TOTO-TEMP-XXX2(z)]]
+    """
+
+  Scenario: Not matching eref_type
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_version:
+      :type: update_eref_version
+      :config:
+        :eref_type: implements
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(a)]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_version thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(a)]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    """
+
+  Scenario: No eref_type
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_version:
+      :type: update_eref_version
+      :config:
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(a)]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_version thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(a)]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1(a)]]
+    """
+
+  Scenario: eref_type with a list
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_external_ref_version:
+      :type: update_eref_version
+      :config:
+        :eref_type:
+        - implements
+        - pouet
+        :ref_document: reference.adoc
+    """
+    And a file named "reference.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(a)]
+    --
+    the requirement value.
+    --
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    defs:eref[pouet, [TOTO-TEMP-XXX1]]
+    """
+    When I successfully run `defmastership modify --modifications update_external_ref_version thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    defs:eref[implements, [TOTO-TEMP-XXX1(a)]]
+    defs:eref[whatever, [TOTO-TEMP-XXX1]]
+    defs:eref[pouet, [TOTO-TEMP-XXX1(a)]]
+    """

data/features/internal_ref_checksum.feature

@@ -0,0 +1,77 @@
+Feature: internal ref checksum
+  As a Responsible of definitions for a given document
+  In order to detect impacts of the modifications of definitions
+  I want defmastership update checksum in definitions internal references
+
+  Scenario Outline: Update one internal ref (<comment>)
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_internal_ref_checksum:
+      :type: update_iref_checksum
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+
+    See defs:iref[TOTO-TEMP-XXX1<before>]
+    """
+    When I successfully run `defmastership modify --modifications update_internal_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+
+    See defs:iref[TOTO-TEMP-XXX1<after>]
+    """
+
+    Examples:
+      | before       | after        | comment                       |
+      |              | (~244eed18)  | No initial checksum           |
+      | (~abcd1234)  | (~244eed18)  | With initial checksum         |
+      | (a)          | (a~244eed18) | With a version                |
+      | (a~abcd1234) | (a~244eed18) | With a version and a checksum |
+
+  Scenario: Update more internal refs
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_internal_ref_checksum:
+      :type: update_iref_checksum
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+
+    [define, requirement, TOTO-TEMP-XXX2]
+    --
+    Another requirement value.
+    --
+
+    See defs:iref[TOTO-TEMP-XXX1] and defs:iref[TOTO-TEMP-XXX2]
+    """
+    When I successfully run `defmastership modify --modifications update_internal_ref_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+
+    [define, requirement, TOTO-TEMP-XXX2]
+    --
+    Another requirement value.
+    --
+
+    See defs:iref[TOTO-TEMP-XXX1(~244eed18)] and defs:iref[TOTO-TEMP-XXX2(~a3c1c965)]
+    """