NAS-101668 / 11.3 / Split on both spaces and tabs for fstab (iocage#929)

* Split on both spaces and tabs for fstab

Previous behavior erroneously expected iocage to be the sole consumer of the fstab.

- This now will skip comments, and split on spaces/tabs as it should have before.
- Move reading fstab to fstab_list() method

iocage side of truenas/middleware#3041

Signed-off-by: Brandon Schneider <[email protected]>

* Doctrees/Docset updates

Signed-off-by: Brandon Schneider <[email protected]>

* We should also not show empty lines

Signed-off-by: Brandon Schneider <[email protected]>

Author: skarekrow

doc/build/doctrees/environment.pickle

@@ -585,7 +585,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>Manipulate a jails fstab</p>
 <dl class="class">
 <dt id="iocage_lib.ioc_fstab.IOCFstab"><a name="//apple_ref/cpp/Class/iocage_lib.ioc_fstab.IOCFstab"></a>
-<em class="property">class </em><code class="descclassname">iocage_lib.ioc_fstab.</code><code class="descname">IOCFstab</code><span class="sig-paren">(</span><em>uuid</em>, <em>action</em>, <em>source=''</em>, <em>destination=''</em>, <em>fstype=''</em>, <em>fsoptions=''</em>, <em>fsdump=''</em>, <em>fspass=''</em>, <em>index=None</em>, <em>silent=False</em>, <em>callback=None</em>, <em>header=False</em>, <em>_fstab_list=None</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_fstab.IOCFstab" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">iocage_lib.ioc_fstab.</code><code class="descname">IOCFstab</code><span class="sig-paren">(</span><em>uuid</em>, <em>action</em>, <em>source=''</em>, <em>destination=''</em>, <em>fstype=''</em>, <em>fsoptions=''</em>, <em>fsdump=''</em>, <em>fspass=''</em>, <em>index=None</em>, <em>silent=False</em>, <em>callback=None</em>, <em>header=False</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_fstab.IOCFstab" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>Will add or remove an entry, and mount or umount the filesystem.</p>
 <dl class="method">
@@ -933,18 +933,18 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>iocage plugin module</p>
 <dl class="class">
 <dt id="iocage_lib.ioc_plugin.IOCPlugin"><a name="//apple_ref/cpp/Class/iocage_lib.ioc_plugin.IOCPlugin"></a>
-<em class="property">class </em><code class="descclassname">iocage_lib.ioc_plugin.</code><code class="descname">IOCPlugin</code><span class="sig-paren">(</span><em>release=None</em>, <em>plugin=None</em>, <em>branch=None</em>, <em>keep_jail_on_failure=False</em>, <em>callback=None</em>, <em>silent=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_plugin.IOCPlugin" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">iocage_lib.ioc_plugin.</code><code class="descname">IOCPlugin</code><span class="sig-paren">(</span><em>release=None</em>, <em>jail=None</em>, <em>plugin=None</em>, <em>branch=None</em>, <em>keep_jail_on_failure=False</em>, <em>callback=None</em>, <em>silent=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_plugin.IOCPlugin" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>This is responsible for the general life cycle of a plugin jail. This
 includes creation, updating and upgrading.</p>
 <dl class="method">
 <dt id="iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin"><a name="//apple_ref/cpp/Method/iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin"></a>
-<code class="descname">fetch_plugin</code><span class="sig-paren">(</span><em>_json</em>, <em>props</em>, <em>num</em>, <em>accept_license</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin" title="Permalink to this definition">¶</a></dt>
+<code class="descname">fetch_plugin</code><span class="sig-paren">(</span><em>props</em>, <em>num</em>, <em>accept_license</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin" title="Permalink to this definition">¶</a></dt>
 <dd><p>Helper to fetch plugins</p>
 </dd></dl>
 <dl class="method">
 <dt id="iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin_index"><a name="//apple_ref/cpp/Method/iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin_index"></a>
-<code class="descname">fetch_plugin_index</code><span class="sig-paren">(</span><em>props</em>, <em>_list=False</em>, <em>list_header=False</em>, <em>list_long=False</em>, <em>accept_license=False</em>, <em>icon=False</em>, <em>official=False</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin_index" title="Permalink to this definition">¶</a></dt>
+<code class="descname">fetch_plugin_index</code><span class="sig-paren">(</span><em>props</em>, <em>_list=False</em>, <em>list_header=False</em>, <em>list_long=False</em>, <em>accept_license=False</em>, <em>icon=False</em>, <em>official=False</em>, <em>index_only=False</em><span class="sig-paren">)</span><a class="headerlink" href="#iocage_lib.ioc_plugin.IOCPlugin.fetch_plugin_index" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 <dl class="method">
 <dt id="iocage_lib.ioc_plugin.IOCPlugin.update"><a name="//apple_ref/cpp/Method/iocage_lib.ioc_plugin.IOCPlugin.update"></a>

doc/build/html/searchindex.js

@@ -44,7 +44,7 @@ class IOCFstab(object):
 
     def __init__(self, uuid, action, source='', destination='', fstype='',
                  fsoptions='', fsdump='', fspass='', index=None, silent=False,
-                 callback=None, header=False, _fstab_list=None
+                 callback=None, header=False
                  ):
         self.pool = iocage_lib.ioc_json.IOCJson().json_get_value("pool")
         self.iocroot = iocage_lib.ioc_json.IOCJson(
@@ -69,16 +69,14 @@ def __init__(self, uuid, action, source='', destination='', fstype='',
 
         self.mount = f'{self.src}\t{self.dest}\t{self.fstype}\t' \
             f'{self.fsoptions}\t{self.fsdump}\t{self.fspass}'
-        self._fstab_list = _fstab_list
         self.header = header
         self.silent = silent
         self.callback = callback
 
-        if action != 'list':
-            self.fstab = list(self.__read_fstab__())
+        self.fstab = list(self.__read_fstab__())
 
-            if action != 'edit':
-                self.dests = self.__validate_fstab__(self.fstab, 'all')
+        if action != 'edit' and action != 'list':
+            self.dests = self.__validate_fstab__(self.fstab, 'all')
 
             self.__fstab_parse__()
 
@@ -128,21 +126,33 @@ def __fstab_parse__(self):
 
     def __read_fstab__(self):
         with open(f"{self.iocroot}/jails/{self.uuid}/fstab", "r") as f:
-            for line in f:
-                yield line.rstrip()
+            for i, line in enumerate(f, ):
+                if not line.strip():
+                    continue
+
+                if not line.strip().startswith('#'):
+                    if self.action != 'list':
+                        yield line.rstrip()
+                    else:
+                        line = line.rsplit('#')[0].rstrip()
+                        yield ([i, line])
 
     def __validate_fstab__(self, fstab, mode='single'):
         dests = {}
         verrors = []
         jail_root = f'{self.iocroot}/jails/{self.uuid}/root'
 
         for index, line in enumerate(fstab):
+            # Comment
+            if line.strip().startswith('#'):
+                continue
             mnt = line.split(' # ')[0]
 
             try:
                 source, destination, fstype, options, \
-                    dump, _pass = line.split('\t')[0:6]
+                    dump, _pass = line.split()[0:6]
                 _pass = _pass.split()[0]  # iocage comment can interfere
+
             except ValueError:
                 verrors.append(
                     f'Malformed fstab at line {index}: {repr(line)}'
@@ -315,7 +325,7 @@ def __fstab_remove__(self):
                 if line.rsplit('#')[0].rstrip() == self.mount \
                         or index == self.index:
                     removed = True
-                    dest = line.split('\t')[1]
+                    dest = line.split()[1]
 
                     continue
 
@@ -441,7 +451,7 @@ def fstab_list(self):
         flat_fstab = [
             (
                 i, self.__fstab_decode__(f)
-            ) for (i, f) in self._fstab_list
+            ) for (i, f) in self.fstab
         ]
 
         if not self.header:

iocage.docset/Contents/Resources/Documents/iocage_lib.html

@@ -1171,15 +1171,6 @@ def fstab(self,
                     },
                     _callback=self.callback,
                     silent=self.silent)
-        else:
-            _fstab_list = []
-            index = 0
-
-            with open(f"{self.iocroot}/jails/{uuid}/fstab", "r") as _fstab:
-                for line in _fstab.readlines():
-                    line = line.rsplit("#")[0].rstrip()
-                    _fstab_list.append([index, line])
-                    index += 1
 
         if action == "list":
             fstab = ioc_fstab.IOCFstab(
@@ -1193,7 +1184,6 @@ def fstab(self,
                 _pass,
                 index=index,
                 header=header,
-                _fstab_list=_fstab_list
             ).fstab_list()
 
             return fstab