Menu ▾ ▴

#598 Include whole files into packages

v1.1.x
closed
Erik Hänel
None
v1.1.3
Change Request
2021-07-19
2021-06-29
Erik Hänel
No

Implement a possibility to include whole files into a package and use this for procedure files to enable installing procedure files including declare statements (see [#526]). A possible solution might be creating a new block statement like

<file name="REL/FILE/PATH">
    FILECONTENTS
<endfile>

Analysis:

The following things have to be considered:

  • The install logic shall be moved completely to Script to reduce unnecessary cluttering of the kernel main loop.
  • In the moment, plugins may only be installed, if they install a procedure file. This has to be resolved as this cannot be longer a real requirement
  • It might be reasonable to actually replace the <install> ... <endinstall> with actual XML, but is not a requirement of this ticket
  • Replacing the current implementation of Script by using StyledTextFile will reduce the duplicated code and will make the code easier to maintain

Implementation:

  • Implementation: Change was implemented as proposed by the analysis.
  • Revision: [r915]
  • Implementation test: Packages were installed with the <file> block and without.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [x] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [ ] not needed
  • Language files:
    • [x] corresponding language files updated
    • [ ] not needed

Tests:

Performed some manual tests and improved the documentation file handling somehow. However, this might be a candidate for future improvement.

Related

Commit: [r915]
Tickets: #526
Tickets: #562

Discussion

  • Erik Hänel

    Erik Hänel - 2021-06-29
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2021-06-29
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -3,3 +3,25 @@
     &lt;file name=&#34;REL/FILE/PATH&#34;&gt;
         FILECONTENTS
     &lt;endfile&gt;

+    
+###Analysis:
+(*Describe, what&#39;s the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you&#39;ve changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**
+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2021-06-30
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -5,7 +5,12 @@
     &lt;endfile&gt;

 ###Analysis:
-(*Describe, what&#39;s the issue and which changes have to be made*)
+The following things have to be considered:
+
+- The install logic shall be moved completely to `Script` to reduce unnecessary cluttering of the kernel main loop.
+- In the moment, plugins may only be installed, if they install a procedure file. This has to be resolved as this cannot be longer a real requirement
+- It might be reasonable to actually replace the `&lt;install&gt; ... &lt;endinstall&gt;` with actual XML, but is not a requirement of this ticket
+- Replacing the current implementation of `Script` by using `StyledTextFile` will reduce the duplicated code and will make the code easier to maintain

 ###Implementation:

 * Implementation: (*Describe, what you&#39;ve changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2021-07-06
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -13,19 +13,19 @@

 - Replacing the current implementation of `Script` by using `StyledTextFile` will reduce the duplicated code and will make the code easier to maintain

 ###Implementation:
-* Implementation: (*Describe, what you&#39;ve changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Change was implemented as proposed by the analysis.
+* Revision: [r915]
+* Implementation test: Packages were installed with the `&lt;file&gt;` block and without.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
-    * [ ] corresponding documentation articles updated
+    * [x] corresponding documentation articles updated
     * [ ] new documentation articles created
     * [ ] not needed
 * **Language files:**
-    * [ ] corresponding language files updated
+    * [x] corresponding language files updated
     * [ ] not needed

 ###Tests:
    • status: implementing --> testing
     

    Related

    Commit: [r915]

  • Erik Hänel

    Erik Hänel - 2021-07-19
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -29,4 +29,4 @@

     * [ ] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Performed some manual tests and improved the documentation file handling somehow. However, this might be a candidate for future improvement.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB