slapos_jio_api_style: try to move the software installation json type class to a mixin

master/bt5/slapos_jio_api_style/MixinTemplateItem/portal_components/mixin.erp5.SoftwareInstallationJsonTypeMixin.py

+##############################################################################
+#
+# Copyright (c) 2024 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+
+import json
+
+class SoftwareInstallationJsonTypeMixin:
+
+  # Declarative security
+  security = ClassSecurityInfo()
+
+  def useRevision(self):
+    return getattr(self, "use_jio_api_revision", False)
+
+  security.declareProtected(Permissions.AccessContentsInformation,
+    'asJSONText')
+  def asJSONText(self):
+    requested_state = self.getSlapState()
+    if requested_state == "stop_requested":
+      state = 'stopped'
+    elif requested_state in ("start_requested", "started"):
+      state = 'available'
+    elif requested_state == "destroy_requested":
+      state = 'destroyed'
+    else:
+      raise ValueError("Unknown slap state : %s" % requested_state)
+    # software instance has to define an xml parameter
+    status_dict = self.getAccessStatus()
+    result = {
+      "$schema": self.getJSONSchemaUrl(),
+      "software_release_uri": self.getUrlString(),
+      "compute_node_id": self.getAggregateReference(),
+      "state": state,
+      "reported_state": status_dict.get("state"),
+      "status_message": status_dict.get("text"),
+      "portal_type": "Software Installation",
+    }
+
+    if self.useRevision():
+      web_section = self.getWebSectionValue()
+      web_section = web_section.getRelativeUrl() if web_section else self.REQUEST.get("web_section_relative_url", None)
+      if web_section:
+        revision = self.getJIOAPIRevision(web_section)
+        if revision:
+          result["api_revision"] = revision
+
+    return json.dumps(result, indent=2)
+
+  def getSlapTimestamp(self):
+    return int(self.getModificationDate())
+
+  security.declareProtected(Permissions.AccessContentsInformation,
+    'getJSONSchemaUrl')
+  def getJSONSchemaUrl(self):
+    """
+    This is an attempt to provide stability to the Schema URL and by extension to asJSONText
+    """
+    portal = self.getPortalObject()
+    portal_type_path = portal.portal_types.restrictedTraverse(self.getPortalType())
+    base_url = portal.portal_preferences.getPreferredSlaposWebSiteUrl().strip("/")
+    return "/".join([base_url, portal_type_path.getRelativeUrl(), "getTextContent"])
\ No newline at end of file

master/bt5/slapos_jio_api_style/MixinTemplateItem/portal_components/mixin.erp5.SoftwareInstallationJsonTypeMixin.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="Mixin Component" module="erp5.portal_type"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>default_reference</string> </key>
+            <value> <string>SoftwareInstallationJsonTypeMixin</string> </value>
+        </item>
+        <item>
+            <key> <string>default_source_reference</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>description</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>mixin.erp5.SoftwareInstallationJsonTypeMixin</string> </value>
+        </item>
+        <item>
+            <key> <string>portal_type</string> </key>
+            <value> <string>Mixin Component</string> </value>
+        </item>
+        <item>
+            <key> <string>sid</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_error_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_warning_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>version</string> </key>
+            <value> <string>erp5</string> </value>
+        </item>
+        <item>
+            <key> <string>workflow_history</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary>
+                <item>
+                    <key> <string>component_validation_workflow</string> </key>
+                    <value>
+                      <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
+                    </value>
+                </item>
+              </dictionary>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="3" aka="AAAAAAAAAAM=">
+    <pickle>
+      <global name="WorkflowHistoryList" module="Products.ERP5Type.Workflow"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_log</string> </key>
+            <value>
+              <list>
+                <dictionary>
+                  <item>
+                      <key> <string>action</string> </key>
+                      <value> <string>validate</string> </value>
+                  </item>
+                  <item>
+                      <key> <string>validation_state</string> </key>
+                      <value> <string>validated</string> </value>
+                  </item>
+                </dictionary>
+              </list>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

master/bt5/slapos_jio_api_style/PortalTypeTypeMixinTemplateItem/type_mixin.xml

@@ -7,6 +7,7 @@
  </portal_type>
  <portal_type id="Software Installation">
   <item>JIOAPIRevisionMixin</item>
+  <item>SoftwareInstallationJsonTypeMixin</item>
  </portal_type>
  <portal_type id="Software Instance">
   <item>JIOAPIRevisionMixin</item>

master/bt5/slapos_jio_api_style/bt/template_mixin_id_list

+mixin.erp5.SoftwareInstallationJsonTypeMixin
\ No newline at end of file

master/bt5/slapos_jio_api_style/bt/template_portal_type_type_mixin_list

 Compute Node | JIOAPIRevisionMixin
 Slave Instance | JIOAPIRevisionMixin
 Software Installation | JIOAPIRevisionMixin
+Software Installation | SoftwareInstallationJsonTypeMixin
 Software Instance | JIOAPIRevisionMixin
\ No newline at end of file