tinfojson -> discojson_sp

Author: enriquepablo

examples/edugain-discojson_sp.yaml

@@ -1,8 +1,8 @@
 - load:
   - "../src/pyff/test/data/metadata/edugain-trustinfo-2.0.xml"
 - select
-- tinfojson
+- discojson_sp
 - publish:
-    output: "./tinfo.json"
+    output: "./disco_sp.json"
     raw: true
     update_store: false

src/pyff/builtins.py

@@ -40,7 +40,7 @@
     set_pubinfo,
     set_reginfo,
     sort_entities,
-    tinfojson_t,
+    discojson_sp_t,
 )
 from pyff.utils import (
     datetime2iso,
@@ -983,14 +983,14 @@ def _discojson(req: Plumbing.Request, *opts):
     return json.dumps(res)
 
 
-@pipe(name='tinfojson')
-def _tinfojson(req, *opts):
+@pipe(name='discojson_sp')
+def _discojson_sp(req, *opts):
     """
 
     Return a json representation of the trust information
 
     .. code-block:: yaml
-      tinfojson:
+      discojson_sp:
 
     The returned json doc will have the following structure.
 
@@ -1039,7 +1039,7 @@ def _tinfojson(req, *opts):
     if req.t is None:
         raise PipeException("Your pipeline is missing a select statement.")
 
-    res = tinfojson_t(req.t)
+    res = discojson_sp_t(req.t)
 
     return json.dumps(res)
 

src/pyff/samlmd.py

@@ -880,58 +880,58 @@ def fetch_mdjson(urls):
     return entities_json
 
 
-def tinfojson(e):
-    tinfo = {}
+def discojson_sp(e):
+    sp = {}
 
     tinfo_el = e.find('.//{%s}TrustInfo' % NS['ti'])
     if tinfo_el is None:
         return None
 
-    tinfo['entityID'] = e.get('entityID', None)
+    sp['entityID'] = e.get('entityID', None)
 
     # grab metadata sources, download metadata, and translate to json
     md_source_urls = [el.text for el in tinfo_el.findall('.//{%s}MetadataSource' % NS['ti'])]
     if len(md_source_urls) > 0:
         try:
-            tinfo['extra_md'] = fetch_mdjson(md_source_urls)
+            sp['extra_md'] = fetch_mdjson(md_source_urls)
         except Exception as e:
             raise ValueError(f"Problem interpreting metadata at {md_source_urls}: {e}")
 
-    tinfo['profiles'] = {}
+    sp['profiles'] = {}
     # Grab trust profile emements, and translate to json
     for profile_el in tinfo_el.findall('.//{%s}TrustProfile' % NS['ti']):
         name = profile_el.attrib['name']
-        tinfo['profiles'][name] = {'entity': [], 'entities': []}
+        sp['profiles'][name] = {'entity': [], 'entities': []}
 
         fallback_handler = tinfo_el.find('.//{%s}FallbackHandler' % NS['ti'])
         if fallback_handler is not None:
             prof = fallback_handler.attrib.get('profile', 'href')
             handler = fallback_handler.text
-            tinfo['profiles'][name]['fallback_handler'] = {'profile': prof, 'handler': handler}
+            sp['profiles'][name]['fallback_handler'] = {'profile': prof, 'handler': handler}
 
         for entity_el in profile_el.findall('.//{%s}TrustedEntity' % NS['ti']):
             entity_id = entity_el.text
             include = entity_el.attrib.get('include', True)
             include = include if type(include) is bool else include in ('t', 'T', 'true', 'True')
-            tinfo['profiles'][name]['entity'].append({'entity_id': entity_id, 'include': include})
+            sp['profiles'][name]['entity'].append({'entity_id': entity_id, 'include': include})
 
         for entities_el in profile_el.findall('.//{%s}TrustedEntities' % NS['ti']):
             select = entities_el.text
             match = entities_el.attrib.get('match', 'registrationAuthority')
             include = entities_el.attrib.get('include', True)
             include = include if type(include) is bool else include in ('t', 'T', 'true', 'True')
-            tinfo['profiles'][name]['entities'].append({'select': select, 'match': match, 'include': include})
+            sp['profiles'][name]['entities'].append({'select': select, 'match': match, 'include': include})
 
-    return tinfo
+    return sp
 
 
-def tinfojson_t(t):
+def discojson_sp_t(t):
     d = []
 
     for e in iter_entities(t):
-        tinfo = tinfojson(e)
-        if tinfo is not None:
-            d.append(tinfo)
+        sp = discojson_sp(e)
+        if sp is not None:
+            d.append(sp)
 
     return d
 

src/pyff/test/test_pipeline.py

@@ -726,7 +726,7 @@ def test_parsecopy_(self):
         assert "Expected exception from bad namespace in"
         assert md.lookup(entity)
 
-    def test_tinfojson(self):
+    def test_discojson_sp(self):
         with patch.multiple("sys", exit=self.sys_exit):
             tmpdir = tempfile.mkdtemp()
             os.rmdir(tmpdir)  # lets make sure 'store' can recreate it
@@ -735,21 +735,21 @@ def test_tinfojson(self):
 - load:
    - file://%s/metadata/test02-sp.xml
 - select
-- tinfojson
+- discojson_sp
 - publish:
-    output: %s/tinfo.json
+    output: %s/disco_sp.json
     raw: true
     update_store: false
 """ % (self.datadir, tmpdir))
-                fn = "%s/tinfo.json" % tmpdir
+                fn = "%s/disco_sp.json" % tmpdir
                 assert os.path.exists(fn)
                 with open(fn, 'r') as f:
-                    tinfo_json = json.load(f)
+                    sp_json = json.load(f)
 
-                assert 'https://example.com.com/shibboleth' in str(tinfo_json)
-                example_tinfo = tinfo_json[0]
-                assert 'customer' in example_tinfo['profiles']
-                customer_tinfo = example_tinfo['profiles']['customer']
+                assert 'https://example.com.com/shibboleth' in str(sp_json)
+                example_sp_json = sp_json[0]
+                assert 'customer' in example_sp_json['profiles']
+                customer_tinfo = example_sp_json['profiles']['customer']
                 assert customer_tinfo['entity'][0] == {'entity_id': 'https://example.org/idp.xml', 'include': True}
                 assert customer_tinfo['entities'][0] == {'select': 'http://www.swamid.se/', 'match': 'registrationAuthority', 'include': True}
                 assert customer_tinfo['fallback_handler'] == {'profile': 'href', 'handler': 'https://www.example.org/about'}