defmastership 1.0.5 → 1.0.10

data/features/definition_checksum.feature

@@ -0,0 +1,298 @@
+Feature: definition checksum 
+  As a Responsible of definitions for a given document
+  In order to detect modifications of defintiions
+  I want defmastership to export and update checksum in definitions
+
+  Scenario: Extract one definition with WRONG explicit checksum to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~babe1234)]
+    def one
+    """
+    When I run `defmastership export thedoc.adoc`
+    Then it should fail with:
+    """
+    warning: TOTO-0001 has a wrong explicit checksum (should be ~d27cb5c3)
+    """
+    And the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,~babe1234
+    """
+    And the stdout should not contain anything
+
+  Scenario: Extract two definitions with one WRONG explicit checksum to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~d27cb5c3)]
+    def one
+
+    [define, requirement, TOTO-0002(~babe1234)]
+    def two
+    """
+    When I run `defmastership export thedoc.adoc`
+    Then it should fail with:
+    """
+    warning: TOTO-0002 has a wrong explicit checksum (should be ~b80e1be5)
+    """
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,\"\"
+    requirement,TOTO-0002,def two,~b80e1be5,~babe1234
+    """
+    And the stdout should not contain anything
+
+  Scenario: Export not failing even if WRONG explicit checksum 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~d27cb5c3)]
+    def one
+
+    [define, requirement, TOTO-0002(~babe1234)]
+    def two
+    """
+    When I successfully run `defmastership export --no-fail thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,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 contain:
+    """
+    warning: TOTO-0002 has a wrong explicit checksum (should be ~b80e1be5)
+    """
+
+  Scenario: Extract one definition with explicit checksum to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~b86dcbde)]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    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: Change one modifier
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum 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-TEMP-XXX1(~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Change one modifier with already set checksum
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(~abcd1234)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum 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-TEMP-XXX1(~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum is calculated on included file for export
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    include::included.txt[]
+    --
+    """
+    And a file named "included.txt" with:
+    """
+    Exemple of multiline requirement.
+    Second line.
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    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: Checksum is calculated on included file in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    include::included.txt[]
+    --
+    """
+    And a file named "included.txt" with:
+    """
+    Exemple of multiline requirement.
+    Second line.
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(~b86dcbde)]
+    --
+    include::included.txt[]
+    --
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Checksum take into account variables in CSV export
+    Given a file named "thedoc.adoc" with:
+    """
+    :variable: multiline
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    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: Checksum take into account variables in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    :variable: multiline
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(~b86dcbde)]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Checksum keep explicit version in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~abcd1234)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum 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-TEMP-XXX1(toto~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum keep explicit version in ref setting
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum 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-TEMP-XXX1(toto~244eed18)]
+    --
+    the requirement value.
+    --
+    """

data/features/definition_version.feature

@@ -0,0 +1,204 @@
+Feature: definitions version 
+  As a Responsible of definitions for a given document 
+  In order to detect handle versions definitions
+  I want defmastership to export explicit versions in definitions
+
+  Scenario: Extract one definition with explicit version to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(pouet)]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Version
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde,pouet
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Set initial explicit version when definition has changed 
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: Do not set initial explicit version when definition has NOT changed 
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    initial text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+
+  Scenario: Set initial explicit version when definition has changed and ref is not an initial version
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(3)]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: 1
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(4)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: No initial explicit version when definition is new
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0002]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: 1
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: update explicit version whith explicit checksum
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever~abcd1234)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a~abcd1234)]
+    --
+    modified text.
+    --
+    """
+