add XMLRCP API to schedule a supportdata action

Author: mcalmer

java/code/src/com/redhat/rhn/frontend/xmlrpc/system/SystemHandler.java

@@ -47,6 +47,7 @@
 import com.redhat.rhn.domain.action.script.ScriptResult;
 import com.redhat.rhn.domain.action.script.ScriptRunAction;
 import com.redhat.rhn.domain.action.server.ServerAction;
+import com.redhat.rhn.domain.action.supportdata.UploadGeoType;
 import com.redhat.rhn.domain.channel.Channel;
 import com.redhat.rhn.domain.channel.ChannelArch;
 import com.redhat.rhn.domain.channel.ChannelFactory;
@@ -9189,6 +9190,45 @@ public CoCoAttestationResult getCoCoAttestationResultDetails(User loggedInUser,
         }
     }
 
+    /**
+     * Schedule Action to get and upload support data from the defined system to SCC.
+     * @param loggedInUser the user
+     * @param sid the system ID
+     * @param caseNumber the support case number
+     * @param parameter additional parameter for the tool which collect the data
+     * @param uploadGeo The location of the upload server [EU, US]
+     * @param earliestOccurrence the date when this action should be executed
+     * @return the action
+     *
+     * @apidoc.doc Schedule an action to get and upload support data from the specified system to SCC.
+     * @apidoc.param #session_key()
+     * @apidoc.param #param("int", "sid")
+     * @apidoc.param #param_desc("string", "caseNumber", "The SCC case number")
+     * @apidoc.param #param_desc("string", "parameter",
+     * "Additional parameter for the tool which collect the data from the system. Can be empty")
+     * @apidoc.param #param_desc("string", "uploadGeo", "The location of the upload server [EU, US]")
+     * @apidoc.param #param("$date",  "earliestOccurrence")
+     * @apidoc.returntype #param_desc("int", "id", "ID of the action scheduled, otherwise exception thrown
+     * on error")
+     */
+    public Integer scheduleSupportDataUpload(User loggedInUser, Integer sid, String caseNumber, String parameter,
+                                             String uploadGeo, Date earliestOccurrence) {
+        try {
+            SystemManager.lookupByIdAndUser(sid.longValue(), loggedInUser);
+
+            Action action = ActionManager.scheduleSupportDataAction(loggedInUser, sid.longValue(),
+                    caseNumber, parameter, UploadGeoType.valueOf(uploadGeo), earliestOccurrence);
+            taskomaticApi.scheduleActionExecution(action);
+            return action.getId().intValue();
+        }
+        catch (LookupException e) {
+            throw new NoSuchSystemException();
+        }
+        catch (com.redhat.rhn.taskomatic.TaskomaticApiException eIn) {
+            throw new TaskomaticApiException(eIn.getMessage());
+        }
+    }
+
     /**
      * Only needed for unit tests.
      * @return the {@link TaskomaticApi} instance used by this class

java/code/src/com/redhat/rhn/frontend/xmlrpc/system/test/SystemHandlerTest.java

@@ -46,6 +46,8 @@
 import com.redhat.rhn.domain.action.script.ScriptRunAction;
 import com.redhat.rhn.domain.action.server.ServerAction;
 import com.redhat.rhn.domain.action.server.test.ServerActionTest;
+import com.redhat.rhn.domain.action.supportdata.SupportDataAction;
+import com.redhat.rhn.domain.action.supportdata.SupportDataActionDetails;
 import com.redhat.rhn.domain.channel.Channel;
 import com.redhat.rhn.domain.channel.ChannelFactory;
 import com.redhat.rhn.domain.channel.ChannelFamily;
@@ -237,6 +239,24 @@ public void setUp() throws Exception {
         super.setUp();
     }
 
+    @Test
+    public void testCreateSupportdataAction() throws Exception {
+        Server server = ServerFactoryTest.createTestServer(admin, true);
+
+        Integer aid = handler.scheduleSupportDataUpload(admin, server.getId().intValue(),
+                "012345", "-i LVM", "EU", getNow());
+        assertNotNull(aid);
+
+        Action action = ActionFactory.lookupById(Long.valueOf(aid));
+        assertEquals(ActionFactory.TYPE_SUPPORTDATA_GET, action.getActionType());
+        assertEquals("Get and Upload Support data", action.getName());
+        SupportDataActionDetails details = ((SupportDataAction) action).getDetails();
+        assertNotNull(details);
+        assertEquals("012345", details.getCaseNumber());
+        assertEquals("-i LVM", details.getParameter());
+        assertEquals("EU", details.getGeoType().name());
+    }
+
     @Test
     public void testGetNetworkDevices() throws Exception {
         Server server = ServerFactoryTest.createTestServer(admin, true);

java/code/src/com/redhat/rhn/manager/action/ActionManager.java

@@ -56,6 +56,9 @@
 import com.redhat.rhn.domain.action.script.ScriptActionDetails;
 import com.redhat.rhn.domain.action.script.ScriptRunAction;
 import com.redhat.rhn.domain.action.server.ServerAction;
+import com.redhat.rhn.domain.action.supportdata.SupportDataAction;
+import com.redhat.rhn.domain.action.supportdata.SupportDataActionDetails;
+import com.redhat.rhn.domain.action.supportdata.UploadGeoType;
 import com.redhat.rhn.domain.common.FileList;
 import com.redhat.rhn.domain.config.ConfigChannel;
 import com.redhat.rhn.domain.config.ConfigFileName;
@@ -2517,6 +2520,38 @@ public static List<Long> changeProxy(User loggedInUser, List<Long> sysids, Long
         return ret;
     }
 
+    /**
+     * Schedule Action to get and upload supportdata from the defined system to SCC.
+     * @param scheduler the scheduler of this action
+     * @param sid the system ID
+     * @param caseNumber the support case number
+     * @param parameter additional parameter for the tool which collect the data
+     * @param uploadGeoType the uploadGeo Type
+     * @param earliest the date when this action should be executed
+     * @return the action
+     */
+    public static Action scheduleSupportDataAction(User scheduler, long sid, String caseNumber, String parameter,
+                                                   UploadGeoType uploadGeoType, Date earliest) {
+        SupportDataAction action = (SupportDataAction) ActionFactory
+                .createAction(ActionFactory.TYPE_SUPPORTDATA_GET, earliest);
+        action.setName("Get and Upload Support data");
+        action.setOrg(scheduler != null ?
+                scheduler.getOrg() : OrgFactory.getSatelliteOrg());
+        action.setSchedulerUser(scheduler);
+
+        SupportDataActionDetails actionDetails = new SupportDataActionDetails();
+        actionDetails.setCaseNumber(caseNumber);
+        actionDetails.setParameter(parameter);
+        actionDetails.setGeoType(uploadGeoType);
+        actionDetails.setParentAction(action);
+
+        action.setDetails(actionDetails);
+        ActionFactory.save(action);
+
+        scheduleForExecution(action, Set.of(sid));
+        return action;
+    }
+
     /**
      * Schedule an immediate Ansible inventory refresh without a user.
      *

java/spacewalk-java.changes.mcalmer.supportdata-db-2

@@ -0,0 +1 @@
+- Implement API to get and upload support data to SCC