Implement basic support for read-only and write-only keys in api_info and api_modify

[felixfontein]

SUMMARY

Ref: https://github.com/ansible-collections/community.routeros/pull/211/files#r1313462457

CC @hansmi - I didn't really have time to test this yet, but if you already want to try it out: enjoy ;-)

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

API data
api_info
api_modify

[codecov]

Codecov Report

Patch coverage: 47.88% and project coverage change: -0.72% ⚠️

Comparison is base (dcc1cf4) 83.87% compared to head (df4c392) 83.15%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #213      +/-   ##
==========================================
- Coverage   83.87%   83.15%   -0.72%     
==========================================
  Files          32       32              
  Lines        3962     4031      +69     
  Branches      837      867      +30     
==========================================
+ Hits         3323     3352      +29     
- Misses        470      494      +24     
- Partials      169      185      +16     

Flag	Coverage Δ
integration	66.86% <ø> (ø)
sanity	22.12% <9.75%> (-0.29%)	⬇️
units	83.10% <47.88%> (-0.74%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
plugins/modules/api_modify.py	73.57% <24.13%> (-3.12%)	⬇️
tests/unit/plugins/modules/fake_api.py	75.47% <55.55%> (-3.14%)	⬇️
plugins/modules/api_info.py	82.92% <57.14%> (-5.24%)	⬇️
plugins/module_utils/_api_data.py	69.38% <100.00%> (+0.85%)	⬆️
tests/unit/plugins/module_utils/test__api_data.py	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main:
https://ansible-collections.github.io/community.routeros/branch/main

[felixfontein]

I did some testing with a modified version of #211:

diff --git a/plugins/module_utils/_api_data.py b/plugins/module_utils/_api_data.py
index 9dbe2a2..b92c611 100644
--- a/plugins/module_utils/_api_data.py
+++ b/plugins/module_utils/_api_data.py
@@ -3231,6 +3231,22 @@ PATHS = {
             },
         ),
     ),
+    ('user',): APIData(
+        unversioned=VersionedAPIData(
+            primary_keys=('name', ),
+            fully_understood=True,
+            fields={
+                'address': KeyInfo(),
+                'comment': KeyInfo(can_disable=True, remove_value=''),
+                'disabled': KeyInfo(default=False),
+                'expired': KeyInfo(read_only=True),
+                'group': KeyInfo(),
+                'last-logged-in': KeyInfo(read_only=True),
+                'name': KeyInfo(),
+                'password': KeyInfo(write_only=True),
+            },
+        ),
+    ),
     ('user', 'aaa'): APIData(
         unversioned=VersionedAPIData(
             single_value=True,

and it works fine (with the last change I pushed).

[felixfontein]

@hansmi thanks for reviewing this!