Merge pull request #45 from PTCInc/44-nested-advanced-tags-groups-not-working-with-adv_tag_groupget_all_tag_groups

fix(adv tags): fixed path split input implementation. Updated Tests

Author: rlabbeptc

docs/kepconfig.html

@@ -114,7 +114,7 @@ <h2 id="features">Features</h2>
 <tr>
   <td style="text-align:center;"><strong>Datalogger</strong> <br /> <em>(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)</em></td>
   <td style="text-align:center;">Y</td>
-  <td style="text-align:center;">Y</td>
+  <td style="text-align:center;">N</td>
 </tr>
 <tr>
   <td style="text-align:center;"><strong>UA Gateway</strong> <br /> <em>(Certificates, Server Endpoints, Client Connections, Server Interface parameters)</em></td>
@@ -370,7 +370,7 @@ <h2 id="need-more-information">Need More Information</h2>
 </span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a><span class="sd">.. include:: ../README.md</span>
 </span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a>
 </span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.4.0&quot;</span>
+</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.4.1&quot;</span>
 </span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">connection</span><span class="p">,</span> <span class="n">error</span>
 </span></pre></div>
 

docs/kepconfig/adv_tags.html

@@ -228,16 +228,18 @@ <h1 class="modulename">
 </span><span id="L-154"><a href="#L-154"><span class="linenos">154</span></a><span class="sd">    :param server: instance of the `server` class</span>
 </span><span id="L-155"><a href="#L-155"><span class="linenos">155</span></a><span class="sd">    :param adv_tag_group_path: path identifying the advanced tag group collection to retrieve. Standard Kepware address decimal</span>
 </span><span id="L-156"><a href="#L-156"><span class="linenos">156</span></a><span class="sd">    notation string such as &quot;_advancedtags.AdvTagGroup1&quot; or &quot;_advancedtags.AdvTagGroup1.AdvTagGroupChild&quot;</span>
-</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a>
-</span><span id="L-158"><a href="#L-158"><span class="linenos">158</span></a><span class="sd">    :return: List of data for all tag groups within the tag group</span>
+</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a><span class="sd">    :param options: *(optional)* Dict of parameters to filter, sort or pagenate the list of tags and tag groups. </span>
+</span><span id="L-158"><a href="#L-158"><span class="linenos">158</span></a><span class="sd">    Options are &#39;filter&#39;, &#39;sortOrder&#39;, and &#39;sortProperty&#39; only.</span>
 </span><span id="L-159"><a href="#L-159"><span class="linenos">159</span></a>
-</span><span id="L-160"><a href="#L-160"><span class="linenos">160</span></a><span class="sd">    :raises KepHTTPError: If urllib provides an HTTPError</span>
-</span><span id="L-161"><a href="#L-161"><span class="linenos">161</span></a><span class="sd">    :raises KepURLError: If urllib provides an URLError</span>
-</span><span id="L-162"><a href="#L-162"><span class="linenos">162</span></a><span class="sd">    &#39;&#39;&#39;</span>
-</span><span id="L-163"><a href="#L-163"><span class="linenos">163</span></a>    <span class="n">path_obj</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_adv_tag_path_split</span><span class="p">(</span><span class="n">adv_tag_group_path</span><span class="p">,</span> <span class="n">isItem</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
-</span><span id="L-164"><a href="#L-164"><span class="linenos">164</span></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_create_adv_tags_base_url</span><span class="p">(</span><span class="n">server</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">path_obj</span><span class="p">)</span> <span class="o">+</span> <span class="n">_create_url</span><span class="p">()</span>
-</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a>    <span class="n">r</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">_config_get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
-</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a>    <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">payload</span>
+</span><span id="L-160"><a href="#L-160"><span class="linenos">160</span></a><span class="sd">    :return: List of data for all tag groups within the tag group</span>
+</span><span id="L-161"><a href="#L-161"><span class="linenos">161</span></a>
+</span><span id="L-162"><a href="#L-162"><span class="linenos">162</span></a><span class="sd">    :raises KepHTTPError: If urllib provides an HTTPError</span>
+</span><span id="L-163"><a href="#L-163"><span class="linenos">163</span></a><span class="sd">    :raises KepURLError: If urllib provides an URLError</span>
+</span><span id="L-164"><a href="#L-164"><span class="linenos">164</span></a><span class="sd">    &#39;&#39;&#39;</span>
+</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a>    <span class="n">path_obj</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_adv_tag_path_split</span><span class="p">(</span><span class="n">adv_tag_group_path</span><span class="p">,</span> <span class="n">isItem</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_create_adv_tags_base_url</span><span class="p">(</span><span class="n">server</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">path_obj</span><span class="p">)</span> <span class="o">+</span> <span class="n">_create_url</span><span class="p">()</span>
+</span><span id="L-167"><a href="#L-167"><span class="linenos">167</span></a>    <span class="n">r</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">_config_get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
+</span><span id="L-168"><a href="#L-168"><span class="linenos">168</span></a>    <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">payload</span>
 </span></pre></div>
 
 
@@ -538,16 +540,18 @@ <h6 id="raises">Raises</h6>
 </span><span id="get_all_tag_groups-155"><a href="#get_all_tag_groups-155"><span class="linenos">155</span></a><span class="sd">    :param server: instance of the `server` class</span>
 </span><span id="get_all_tag_groups-156"><a href="#get_all_tag_groups-156"><span class="linenos">156</span></a><span class="sd">    :param adv_tag_group_path: path identifying the advanced tag group collection to retrieve. Standard Kepware address decimal</span>
 </span><span id="get_all_tag_groups-157"><a href="#get_all_tag_groups-157"><span class="linenos">157</span></a><span class="sd">    notation string such as &quot;_advancedtags.AdvTagGroup1&quot; or &quot;_advancedtags.AdvTagGroup1.AdvTagGroupChild&quot;</span>
-</span><span id="get_all_tag_groups-158"><a href="#get_all_tag_groups-158"><span class="linenos">158</span></a>
-</span><span id="get_all_tag_groups-159"><a href="#get_all_tag_groups-159"><span class="linenos">159</span></a><span class="sd">    :return: List of data for all tag groups within the tag group</span>
+</span><span id="get_all_tag_groups-158"><a href="#get_all_tag_groups-158"><span class="linenos">158</span></a><span class="sd">    :param options: *(optional)* Dict of parameters to filter, sort or pagenate the list of tags and tag groups. </span>
+</span><span id="get_all_tag_groups-159"><a href="#get_all_tag_groups-159"><span class="linenos">159</span></a><span class="sd">    Options are &#39;filter&#39;, &#39;sortOrder&#39;, and &#39;sortProperty&#39; only.</span>
 </span><span id="get_all_tag_groups-160"><a href="#get_all_tag_groups-160"><span class="linenos">160</span></a>
-</span><span id="get_all_tag_groups-161"><a href="#get_all_tag_groups-161"><span class="linenos">161</span></a><span class="sd">    :raises KepHTTPError: If urllib provides an HTTPError</span>
-</span><span id="get_all_tag_groups-162"><a href="#get_all_tag_groups-162"><span class="linenos">162</span></a><span class="sd">    :raises KepURLError: If urllib provides an URLError</span>
-</span><span id="get_all_tag_groups-163"><a href="#get_all_tag_groups-163"><span class="linenos">163</span></a><span class="sd">    &#39;&#39;&#39;</span>
-</span><span id="get_all_tag_groups-164"><a href="#get_all_tag_groups-164"><span class="linenos">164</span></a>    <span class="n">path_obj</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_adv_tag_path_split</span><span class="p">(</span><span class="n">adv_tag_group_path</span><span class="p">,</span> <span class="n">isItem</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
-</span><span id="get_all_tag_groups-165"><a href="#get_all_tag_groups-165"><span class="linenos">165</span></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_create_adv_tags_base_url</span><span class="p">(</span><span class="n">server</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">path_obj</span><span class="p">)</span> <span class="o">+</span> <span class="n">_create_url</span><span class="p">()</span>
-</span><span id="get_all_tag_groups-166"><a href="#get_all_tag_groups-166"><span class="linenos">166</span></a>    <span class="n">r</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">_config_get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
-</span><span id="get_all_tag_groups-167"><a href="#get_all_tag_groups-167"><span class="linenos">167</span></a>    <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">payload</span>
+</span><span id="get_all_tag_groups-161"><a href="#get_all_tag_groups-161"><span class="linenos">161</span></a><span class="sd">    :return: List of data for all tag groups within the tag group</span>
+</span><span id="get_all_tag_groups-162"><a href="#get_all_tag_groups-162"><span class="linenos">162</span></a>
+</span><span id="get_all_tag_groups-163"><a href="#get_all_tag_groups-163"><span class="linenos">163</span></a><span class="sd">    :raises KepHTTPError: If urllib provides an HTTPError</span>
+</span><span id="get_all_tag_groups-164"><a href="#get_all_tag_groups-164"><span class="linenos">164</span></a><span class="sd">    :raises KepURLError: If urllib provides an URLError</span>
+</span><span id="get_all_tag_groups-165"><a href="#get_all_tag_groups-165"><span class="linenos">165</span></a><span class="sd">    &#39;&#39;&#39;</span>
+</span><span id="get_all_tag_groups-166"><a href="#get_all_tag_groups-166"><span class="linenos">166</span></a>    <span class="n">path_obj</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_adv_tag_path_split</span><span class="p">(</span><span class="n">adv_tag_group_path</span><span class="p">,</span> <span class="n">isItem</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
+</span><span id="get_all_tag_groups-167"><a href="#get_all_tag_groups-167"><span class="linenos">167</span></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">adv_tags</span><span class="o">.</span><span class="n">_create_adv_tags_base_url</span><span class="p">(</span><span class="n">server</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">path_obj</span><span class="p">)</span> <span class="o">+</span> <span class="n">_create_url</span><span class="p">()</span>
+</span><span id="get_all_tag_groups-168"><a href="#get_all_tag_groups-168"><span class="linenos">168</span></a>    <span class="n">r</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">_config_get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
+</span><span id="get_all_tag_groups-169"><a href="#get_all_tag_groups-169"><span class="linenos">169</span></a>    <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">payload</span>
 </span></pre></div>
 
 
@@ -559,6 +563,8 @@ <h6 id="parameters">Parameters</h6>
 <li><strong>server</strong>:  instance of the <code>server</code> class</li>
 <li><strong>adv_tag_group_path</strong>:  path identifying the advanced tag group collection to retrieve. Standard Kepware address decimal
 notation string such as "_advancedtags.AdvTagGroup1" or "_advancedtags.AdvTagGroup1.AdvTagGroupChild"</li>
+<li><strong>options</strong>:  <em>(optional)</em> Dict of parameters to filter, sort or pagenate the list of tags and tag groups. 
+Options are 'filter', 'sortOrder', and 'sortProperty' only.</li>
 </ul>
 
 <h6 id="returns">Returns</h6>

docs/kepconfig/adv_tags/adv_tag_group.html

@@ -8,6 +8,7 @@
 specific objects within the Kepware Configuration API
 """
 
+from ..error import KepError
 from . import adv_tag_group, average_tags, derived_tags, complex_tags, cumulative_tags, min_tags, max_tags, link_tags
 ADV_TAGS_ROOT = '/project/_advancedtags'
 
@@ -28,6 +29,9 @@ def _adv_tag_path_split(path: str, *, isItem=False) -> dict:
     return = {'adv_tag_root': '_advancedtags', 'tag_path': ['ch1','dev1']}
     '''
     path_list = path.split('.', 2)
+    if path_list[0] != '_advancedtags':
+        raise KepError('Error: Invalid advanced tag path - Must start with "_advancedtags"')
+     
     path_obj = {}
     for x in range(0, len(path_list)):
         if x == 0:

docs/search.js

@@ -154,13 +154,15 @@ def get_all_tag_groups(server: server, adv_tag_group_path: str, *, options: dict
     :param server: instance of the `server` class
     :param adv_tag_group_path: path identifying the advanced tag group collection to retrieve. Standard Kepware address decimal
     notation string such as "_advancedtags.AdvTagGroup1" or "_advancedtags.AdvTagGroup1.AdvTagGroupChild"
+    :param options: *(optional)* Dict of parameters to filter, sort or pagenate the list of tags and tag groups. 
+    Options are 'filter', 'sortOrder', and 'sortProperty' only.
 
     :return: List of data for all tag groups within the tag group
 
     :raises KepHTTPError: If urllib provides an HTTPError
     :raises KepURLError: If urllib provides an URLError
     '''
-    path_obj = adv_tags._adv_tag_path_split(adv_tag_group_path, isItem=True)
+    path_obj = adv_tags._adv_tag_path_split(adv_tag_group_path, isItem=False)
     url = adv_tags._create_adv_tags_base_url(server.url, path_obj) + _create_url()
     r = server._config_get(url, params=options)
     return r.payload

kepconfig/adv_tags/__init__.py

@@ -222,10 +222,20 @@ def test_adv_tag_group_get(server):
     assert type(adv_tags.adv_tag_group.get_tag_group(server, adv_tag_child_group_path)) == dict
 
     # Get all advanced tag groups at root
-    assert type(adv_tags.adv_tag_group.get_all_tag_groups(server, '')) == list
+    assert type(adv_tags.adv_tag_group.get_all_tag_groups(server, '_advancedtags')) == list
 
     # Get all advanced tag groups under a parent
-    assert type(adv_tags.adv_tag_group.get_all_tag_groups(server, f'_advancedtags.{adv_tag_group_name}')) == list
+    result = adv_tags.adv_tag_group.get_all_tag_groups(server, f'_advancedtags.{adv_tag_group_name}')
+    assert type(result) == list
+    assert any(group["common.ALLTYPES_NAME"] == adv_tag_group_child for group in result)
+    result = adv_tags.adv_tag_group.get_all_tag_groups(server, adv_tag_child_group_path)
+    assert type(result) == list
+    assert len(result) == 0
+
+def test_adv_tag_bad_root_in_path(server):
+    # Test bad advanced tag path
+    with pytest.raises(error.KepError):
+        adv_tags.adv_tag_group.get_tag_group(server, '_wrongroot.AdvTagGroup1')
 
 def test_adv_tag_group_modify(server):
     # Modify advanced tag group