Added json method to Entity #326

renzon · 2016-10-19T20:04:53Z

close #323

Once the methods uses _payload, some Entities maybe need
override this to match names expected on API

I followed @elyezer tip and made a this POC that worked for simple properties: renzon@d092468.

The problem is when the default naming mapping is not correct with the expected for API. But in this case Subclasses can override _to_json_dict for the exceptions.

@ehelms and @rochacbruno could give it a try to check exceptions as they use it and creating issues here for them. What you guys think?

omaciel · 2016-10-19T20:09:34Z

@Ichimonji10 could I ask you for your opinion here?

coveralls · 2016-10-20T17:18:55Z

Coverage increased (+0.004%) to 98.537% when pulling c4d3dd3 on renzon:323 into 40ee56f on SatelliteQE:master.

ehelms · 2016-10-20T17:58:16Z

I think, based on the output below, I will also need json.dumps to work for taking a large data structure containing Nailgun classes and turning them into JSON.

  File "/tmp/ansible_Xv6fUt/ansible_module_katello.py", line 451, in compare
    return json.dumps(reports)
  File "/usr/lib64/python2.7/json/__init__.py", line 244, in dumps
    return _default_encoder.encode(obj)
  File "/usr/lib64/python2.7/json/encoder.py", line 207, in encode
    chunks = self.iterencode(o, _one_shot=True)
  File "/usr/lib64/python2.7/json/encoder.py", line 270, in iterencode
    return _iterencode(o, 0)
  File "/usr/lib64/python2.7/json/encoder.py", line 184, in default
    raise TypeError(repr(o) + " is not JSON serializable")
TypeError: nailgun.entities.Package(nailgun.config.ServerConfig(url='https://sat-r220-02.lab.eng.rdu2.redhat.com/', verify=False, auth=('admin', 'changeme')), nvrea=u'sclo-git25-1.0-2.el7.x86_64', checksum=u'751e639a0b8add0adc0c5cf0bf77693b3197b17533037ce2e7b9daa618898b99', summary=u'Package that installs sclo-git25', filename=u'sclo-git25-1.0-2.el7.x86_64.rpm', epoch=u'0', version=u'1.0', nvra=u'sclo-git25-1.0-2.el7.x86_64', release=u'2.el7', sourcerpm=u'sclo-git25-1.0-2.el7.src.rpm', arch=u'x86_64', id=64529, name=u'sclo-git25') is not JSON serializable

renzon · 2016-10-26T15:54:33Z

@ehelms I suppose you want nested strutures, right? Using default _parse function it just tranform complex structures on their respective id. Check Repository parsed to id. If nested is what you want I can try it, I mean, if you would expect something like:

{ # package regular fields
    {'repository': {'id' : 1}}
}

renzon · 2016-10-26T16:47:55Z

@ehelms I played with the nested structure on last commit, check if it works for you

coveralls · 2016-10-27T10:32:16Z

Coverage decreased (-0.04%) to 98.502% when pulling 73b0207 on renzon:323 into 272ff30 on SatelliteQE:master.

close SatelliteQE#323

coveralls · 2016-10-31T11:29:34Z

Coverage decreased (-0.04%) to 98.508% when pulling 1b4a70f on renzon:323 into 272ff30 on SatelliteQE:master.

renzon · 2016-11-04T18:30:09Z

@ehelms last time we spoke it was working in your tests. Is it still working? Let me know if it is so folk can merge and made a new version available on pypi ;)

abalakh

ACK pending some small comments

abalakh · 2016-11-07T13:24:23Z

tests/test_entities.py

+            'name': u'sclo-git25'
+        }
+        cfg = config.ServerConfig(
+            url='https://sat-r220-02.lab.eng.rdu2.redhat.com/', verify=False,


Please remove internal url, we shouldn't use any of such in our public repos

abalakh · 2016-11-07T13:24:32Z

tests/test_entities.py

+            'name': u'sclo-git25'
+        }
+        cfg = config.ServerConfig(
+            url='https://sat-r220-02.lab.eng.rdu2.redhat.com/', verify=False,


Please remove internal url

abalakh · 2016-11-07T13:29:19Z

nailgun/entity_mixins.py

@@ -510,6 +511,44 @@ def __repr__(self):
            )
        )

+    def to_json(self):
+        r"""Create a JSON encoded string with Entity properties. Ex:


Empty line needed here

Btw what does that r""" format stands for?

@abalakh : this is for Sphinx and Flake do not fail when reading my string. I got Travis errors while generating doc and solved after checking it on SO:

Without the raw string you could use \\**kwargs, that should work.

abalakh · 2016-11-07T13:29:36Z

nailgun/entity_mixins.py

+        >>> org.to_json()
+        '{"id": 1, "name": "Nailgun Org"}')
+
+        :return: str


And another empty line after this one

abalakh · 2016-11-07T13:33:24Z

nailgun/entity_mixins.py

+        and build a list calling the same method on each object on OneToMany
+        fields.
+
+        :return: dct


Another empty line needed here:

System Message: WARNING/2 (<string>, line 8) Field list ends without a blank line; unexpected unindent.

abalakh · 2016-11-07T13:34:43Z

nailgun/entities.py

+    """ Transforms obj into a json serializable object.
+
+    :param obj: entity or any json serializable object
+    :return: serializable object


Empty line is needed after this line:

System Message: WARNING/2 (<string>, line 5) Field list ends without a blank line; unexpected unindent.

abalakh · 2016-11-07T13:44:12Z

nailgun/entity_mixins.py

+        ...     }
+        >>> org = entities.Organization(config.ServerConfig('foo'), \*\*kwargs)
+        >>> org.to_json()
+        '{"id": 1, "name": "Nailgun Org"}')


nitpick: closing bracket is probably redundant here

abalakh · 2016-11-07T14:26:21Z

nailgun/entity_mixins.py

+                if isinstance(field, OneToOneField):
+                    json_dct[field_name] = values[field_name].to_json_dict()
+                elif isinstance(field, OneToManyField):
+                    json_dct[field_name] = [


This line is not covered by tests

abalakh · 2016-11-07T14:28:32Z

Btw please include transformation result for one 'real' entity with numerous fields/subentities.

close SatelliteQE#323

coveralls · 2016-11-07T16:51:23Z

Coverage increased (+0.02%) to 98.567% when pulling 1e3e291 on renzon:323 into 272ff30 on SatelliteQE:master.

abalakh

ACK pending the last nitpick

abalakh · 2016-11-09T10:23:15Z

nailgun/entity_mixins.py

+        >>> org.to_json()
+        '{"id": 1, "name": "Nailgun Org"}'
+
+        :return: str


And the last one empty line missing after this one

coveralls · 2016-11-09T17:24:13Z

Coverage increased (+0.02%) to 98.567% when pulling 4204168 on renzon:323 into 272ff30 on SatelliteQE:master.

abalakh · 2016-11-09T21:42:40Z

@renzon you misunderstood my suggestion, i was asking about adding a blank line after :return:, not about removing it :)
It's just some rst checkers complain that blank line is needed after it like this:

System Message: WARNING/2 (<string>, line 8)

Field list ends without a blank line; unexpected unindent.

However, I've checked sphinx and it didn't throw any warning, build succeeded and resulting doc had no issues, so i can't see the reason to block this PR anymore, my suggestion is definitely optional.

rochacbruno · 2016-11-11T14:22:32Z

@renzon can you put some demonstration on Nailgun docs? some examples on how to use and also output examples of json methods.

maybe in http://nailgun.readthedocs.io/en/latest/examples.html (https://github.com/SatelliteQE/nailgun/blob/master/docs/examples.rst)

coveralls · 2016-11-11T16:12:38Z

Coverage increased (+0.02%) to 98.567% when pulling 3a904be on renzon:323 into 272ff30 on SatelliteQE:master.

rochacbruno · 2016-11-18T15:33:45Z

ACK

Shortlog of commits since last release: Andrii Balakhtar (4): Fix read() of hostgroup without content_source, lce or cv for 6.1 Increase timeout for manifest delete/refresh (SatelliteQE#359) Provide default name length & type for ComputeResource entities (SatelliteQE#369) Implemented Interface entity with all its fields and basic operations (SatelliteQE#373) Djebran Lezzoum (1): Merge pull request SatelliteQE#380 from svtkachenko/ct_update_payload Elyézer Rezende (1): Update travis config Oleksandr Shtaier (8): Merge pull request SatelliteQE#341 from sghai/update-test Merge pull request SatelliteQE#342 from renzon/332 Merge pull request SatelliteQE#344 from elyezer/update-travis Merge pull request SatelliteQE#352 from svtkachenko/sv_payload Merge pull request SatelliteQE#345 from abalakh/fix_hg_61_workaround Merge pull request SatelliteQE#366 from svtkachenko/update_template_kind Merge pull request SatelliteQE#361 from svtkachenko/update_sv Merge pull request SatelliteQE#383 from svtkachenko/63_image Renzo Nuccitelli (3): Added json method to Entity (SatelliteQE#326) Merge pull request SatelliteQE#347 from svtkachenko/add_image Implemented Entity __eq__ method comparing all fields (SatelliteQE#350) Stanislav Tkachenko (10): Add content related helpers for Repository entity. (SatelliteQE#327) Add Create and Delete mixins to Smart Proxy (SatelliteQE#343) Add mixins to Image Override create_payload and upload_payload for SmartVariable. Update Host.puppet_class field name. (SatelliteQE#346) Removed overriden read method for Smart Variable Update TemplateKind entity Add ProvisioningTemplate. (SatelliteQE#365) Fix update_payload method for ConfigTemplate/ProvisioningTemplate [6.2.z] Update Image and Host entities (SatelliteQE#356) oshtaier (2): Add UpdateMixin for CV Filter Rules entity Add host count field to CV entity renzon (5): Fixed ConfigTemplate create and update with TemplateCombination ListFiled handled on _payload api fixed and methods GET and DELETED added for TemplateCombination api fixed and methods GET and DELETED added for TemplateCombination api fixed and methods GET and DELETED added for TemplateCombination sghai (5): Updated discovery_rule entity with org & location (SatelliteQE#320) Added a new field root_pass to hostgroup entity (SatelliteQE#336) Added unit test for root_pass from hostgroup entity Merge pull request SatelliteQE#338 from oshtaier/cvf_update_mixin Merge pull request SatelliteQE#340 from oshtaier/cv_field

* Added nested json parsing to Entity close SatelliteQE#323 * Added to_json_serializable function close SatelliteQE#323 * Fixed last nitpick on docstrings * Added docs for to_json_serializable function

Shortlog of commits since last release: Andrii Balakhtar (4): Fix read() of hostgroup without content_source, lce or cv for 6.1 Increase timeout for manifest delete/refresh (SatelliteQE#359) Provide default name length & type for ComputeResource entities (SatelliteQE#369) Implemented Interface entity with all its fields and basic operations (SatelliteQE#373) Djebran Lezzoum (1): Merge pull request SatelliteQE#380 from svtkachenko/ct_update_payload Elyézer Rezende (1): Update travis config Oleksandr Shtaier (8): Merge pull request SatelliteQE#341 from sghai/update-test Merge pull request SatelliteQE#342 from renzon/332 Merge pull request SatelliteQE#344 from elyezer/update-travis Merge pull request SatelliteQE#352 from svtkachenko/sv_payload Merge pull request SatelliteQE#345 from abalakh/fix_hg_61_workaround Merge pull request SatelliteQE#366 from svtkachenko/update_template_kind Merge pull request SatelliteQE#361 from svtkachenko/update_sv Merge pull request SatelliteQE#383 from svtkachenko/63_image Renzo Nuccitelli (3): Added json method to Entity (SatelliteQE#326) Merge pull request SatelliteQE#347 from svtkachenko/add_image Implemented Entity __eq__ method comparing all fields (SatelliteQE#350) Stanislav Tkachenko (10): Add content related helpers for Repository entity. (SatelliteQE#327) Add Create and Delete mixins to Smart Proxy (SatelliteQE#343) Add mixins to Image Override create_payload and upload_payload for SmartVariable. Update Host.puppet_class field name. (SatelliteQE#346) Removed overriden read method for Smart Variable Update TemplateKind entity Add ProvisioningTemplate. (SatelliteQE#365) Fix update_payload method for ConfigTemplate/ProvisioningTemplate [6.2.z] Update Image and Host entities (SatelliteQE#356) oshtaier (2): Add UpdateMixin for CV Filter Rules entity Add host count field to CV entity renzon (5): Fixed ConfigTemplate create and update with TemplateCombination ListFiled handled on _payload api fixed and methods GET and DELETED added for TemplateCombination api fixed and methods GET and DELETED added for TemplateCombination api fixed and methods GET and DELETED added for TemplateCombination sghai (5): Updated discovery_rule entity with org & location (SatelliteQE#320) Added a new field root_pass to hostgroup entity (SatelliteQE#336) Added unit test for root_pass from hostgroup entity Merge pull request SatelliteQE#338 from oshtaier/cvf_update_mixin Merge pull request SatelliteQE#340 from oshtaier/cv_field

renzon added the in progress label Oct 19, 2016

renzon force-pushed the 323 branch 3 times, most recently from 1f53a0c to c4d3dd3 Compare October 20, 2016 17:17

renzon force-pushed the 323 branch from c5d6077 to 8acad9e Compare October 26, 2016 15:48

renzon force-pushed the 323 branch 2 times, most recently from 6689d84 to 73b0207 Compare October 27, 2016 10:30

Added nested json parsing to Entity

85daedd

close SatelliteQE#323

renzon force-pushed the 323 branch 3 times, most recently from ba5de65 to 1b4a70f Compare October 31, 2016 11:27

renzon added review and removed in progress labels Nov 4, 2016

abalakh suggested changes Nov 7, 2016

View reviewed changes

abalakh reviewed Nov 7, 2016

View reviewed changes

renzon force-pushed the 323 branch 5 times, most recently from 7afdcc1 to a001a90 Compare November 7, 2016 16:43

Added to_json_serializable function

1e3e291

close SatelliteQE#323

renzon force-pushed the 323 branch from a001a90 to 1e3e291 Compare November 7, 2016 16:46

abalakh suggested changes Nov 9, 2016

View reviewed changes

Fixed last nitpick on docstrings

4204168

abalakh approved these changes Nov 9, 2016

View reviewed changes

rochacbruno mentioned this pull request Nov 11, 2016

Make entities __eq__ comparable #335

Closed

Added docs for to_json_serializable function

3a904be

renzon self-assigned this Nov 15, 2016

rochacbruno merged commit 2dc93ba into SatelliteQE:master Nov 18, 2016

rochacbruno removed the review label Nov 18, 2016

renzon deleted the 323 branch December 16, 2016 09:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added json method to Entity #326

Added json method to Entity #326

renzon commented Oct 19, 2016

omaciel commented Oct 19, 2016

coveralls commented Oct 20, 2016 •

edited

Loading

ehelms commented Oct 20, 2016

renzon commented Oct 26, 2016 •

edited

Loading

renzon commented Oct 26, 2016

coveralls commented Oct 27, 2016 •

edited

Loading

coveralls commented Oct 31, 2016 •

edited

Loading

renzon commented Nov 4, 2016

abalakh left a comment

abalakh Nov 7, 2016

abalakh Nov 7, 2016

abalakh Nov 7, 2016

abalakh Nov 7, 2016

renzon Nov 7, 2016

elyezer Nov 7, 2016 •

edited

Loading

abalakh Nov 7, 2016

abalakh Nov 7, 2016

abalakh Nov 7, 2016

abalakh Nov 7, 2016

abalakh Nov 7, 2016

abalakh commented Nov 7, 2016

coveralls commented Nov 7, 2016 •

edited

Loading

abalakh left a comment

abalakh Nov 9, 2016

coveralls commented Nov 9, 2016 •

edited

Loading

abalakh commented Nov 9, 2016

rochacbruno commented Nov 11, 2016

coveralls commented Nov 11, 2016 •

edited

Loading

rochacbruno commented Nov 18, 2016

Added json method to Entity #326

Added json method to Entity #326

Conversation

renzon commented Oct 19, 2016

omaciel commented Oct 19, 2016

coveralls commented Oct 20, 2016 • edited Loading

ehelms commented Oct 20, 2016

renzon commented Oct 26, 2016 • edited Loading

renzon commented Oct 26, 2016

coveralls commented Oct 27, 2016 • edited Loading

coveralls commented Oct 31, 2016 • edited Loading

renzon commented Nov 4, 2016

abalakh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elyezer Nov 7, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abalakh commented Nov 7, 2016

coveralls commented Nov 7, 2016 • edited Loading

abalakh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Nov 9, 2016 • edited Loading

abalakh commented Nov 9, 2016

rochacbruno commented Nov 11, 2016

coveralls commented Nov 11, 2016 • edited Loading

rochacbruno commented Nov 18, 2016

coveralls commented Oct 20, 2016 •

edited

Loading

renzon commented Oct 26, 2016 •

edited

Loading

coveralls commented Oct 27, 2016 •

edited

Loading

coveralls commented Oct 31, 2016 •

edited

Loading

elyezer Nov 7, 2016 •

edited

Loading

coveralls commented Nov 7, 2016 •

edited

Loading

coveralls commented Nov 9, 2016 •

edited

Loading

coveralls commented Nov 11, 2016 •

edited

Loading