From commits-return-9297-archive-asf-public=cust-asf.ponee.io@fineract.apache.org Thu May 21 21:53:51 2020 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 0FD771804BB for ; Thu, 21 May 2020 23:53:50 +0200 (CEST) Received: (qmail 43488 invoked by uid 500); 21 May 2020 21:53:50 -0000 Mailing-List: contact commits-help@fineract.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@fineract.apache.org Delivered-To: mailing list commits@fineract.apache.org Received: (qmail 43479 invoked by uid 99); 21 May 2020 21:53:50 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 21 May 2020 21:53:50 +0000 From: =?utf-8?q?GitBox?= To: commits@fineract.apache.org Subject: =?utf-8?q?=5BGitHub=5D_=5Bfineract=5D_vorburger_commented_on_a_change_in_pul?= =?utf-8?q?l_request_=23817=3A_Step_1_of_improving_SchedulerJobHelper_to_be_?= =?utf-8?q?more_reliable_and_prevent_flaky_tests_=28FINERACT-922=29?= Message-ID: <159009803026.19379.7385802454090350826.asfpy@gitbox.apache.org> Date: Thu, 21 May 2020 21:53:50 -0000 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit References: In-Reply-To: vorburger commented on a change in pull request #817: URL: https://github.com/apache/fineract/pull/817#discussion_r428936852 ########## File path: fineract-provider/src/integrationTest/java/org/apache/fineract/integrationtests/common/SchedulerJobHelper.java ########## @@ -122,45 +139,112 @@ private static String runSchedulerJobAsJSON() { return runSchedulerJob; } - public void executeJob(String jobName) throws InterruptedException { - List allSchedulerJobsData = getAllSchedulerJobs(); - Assert.assertNotNull(allSchedulerJobsData); - + private int getSchedulerJobIdByName(String jobName) { + List> allSchedulerJobsData = getAllSchedulerJobs(); for (Integer jobIndex = 0; jobIndex < allSchedulerJobsData.size(); jobIndex++) { if (allSchedulerJobsData.get(jobIndex).get("displayName").equals(jobName)) { - Integer jobId = (Integer) allSchedulerJobsData.get(jobIndex).get("jobId"); + return (Integer) allSchedulerJobsData.get(jobIndex).get("jobId"); + } + } + throw new IllegalArgumentException("No such named Job (see org.apache.fineract.infrastructure.jobs.service.JobName enum):" + jobName); + } - // Executing Scheduler Job - runSchedulerJob(this.requestSpec, jobId.toString()); + @Deprecated // FINERACT-922 TODO Gradually replace use of this method with new executeAndAwaitJob() below, if it proves to be more stable than this one + public void executeJob(String jobName) throws InterruptedException { + // Stop the Scheduler while we manually trigger execution of job, to avoid side effects and simplify debugging when readings logs + updateSchedulerStatus(false); + + int jobId = getSchedulerJobIdByName(jobName); - // Retrieving Scheduler Job by ID - Map schedulerJob = getSchedulerJobById(jobId); - Assert.assertNotNull(schedulerJob); + // Executing Scheduler Job + runSchedulerJob(jobId); - // Waiting for Job to complete - while ((Boolean) schedulerJob.get("currentlyRunning") == true) { - Thread.sleep(15000); - schedulerJob = getSchedulerJobById(jobId); - Assert.assertNotNull(schedulerJob); - System.out.println("Job is Still Running"); - } + // Retrieving Scheduler Job by ID + Map schedulerJob = getSchedulerJobById(jobId); - List jobHistoryData = getSchedulerJobHistory(jobId); + // Waiting for Job to complete + while ((Boolean) schedulerJob.get("currentlyRunning") == true) { + Thread.sleep(15000); + schedulerJob = getSchedulerJobById(jobId); + assertNotNull(schedulerJob); + System.out.println("Job is Still Running"); + } - Assert.assertFalse("Job History is empty :( Was it too slow? Failures in background job?", jobHistoryData.isEmpty()); + List> jobHistoryData = getSchedulerJobHistory(jobId); - // print error associated with recent job failure (if any) - System.out.println("Job run error message (printed only if the job fails: " - + jobHistoryData.get(jobHistoryData.size() - 1).get("jobRunErrorMessage")); - System.out.println("Job failure error log (printed only if the job fails: " - + jobHistoryData.get(jobHistoryData.size() - 1).get("jobRunErrorLog")); + assertFalse("Job History is empty :( Was it too slow? Failures in background job?", jobHistoryData.isEmpty()); - // Verifying the Status of the Recently executed Scheduler Job - Assert.assertEquals("Verifying Last Scheduler Job Status", "success", - jobHistoryData.get(jobHistoryData.size() - 1).get("status")); + // print error associated with recent job failure (if any) + System.out.println("Job run error message (printed only if the job fails: " + + jobHistoryData.get(jobHistoryData.size() - 1).get("jobRunErrorMessage")); + System.out.println("Job failure error log (printed only if the job fails: " + + jobHistoryData.get(jobHistoryData.size() - 1).get("jobRunErrorLog")); + + // Verifying the Status of the Recently executed Scheduler Job + assertEquals("Verifying Last Scheduler Job Status", "success", + jobHistoryData.get(jobHistoryData.size() - 1).get("status")); + } - break; + /** + * Launches a Job and awaits its completion. + * @param jobName displayName (see {@link org.apache.fineract.infrastructure.jobs.service.JobName}) of Scheduler Job + * + * @author Michael Vorburger.ch + */ + public void executeAndAwaitJob(String jobName) { + Duration TIMEOUT = Duration.ofSeconds(30); + Duration PAUSE = Duration.ofMillis(500); + DateTimeFormatter df = DateTimeFormatter.ISO_INSTANT; // FINERACT-926 + Instant beforeExecuteTime = now().truncatedTo(ChronoUnit.SECONDS); + + // Stop the Scheduler while we manually trigger execution of job, to avoid side effects and simplify debugging when readings logs + updateSchedulerStatus(false); + + // Executing Scheduler Job + int jobId = getSchedulerJobIdByName(jobName); + runSchedulerJob(jobId); + + // Await JobDetailData.lastRunHistory [JobDetailHistoryData] jobRunStartTime >= beforeExecuteTime (or timeout) + await().atMost(TIMEOUT).pollInterval(PAUSE).until(jobLastRunHistorySupplier(jobId), lastRunHistory -> { + String jobRunStartText = lastRunHistory.get("jobRunStartTime"); + if (jobRunStartText == null) { + return false; } + Instant jobRunStartTime = df.parse(jobRunStartText, Instant::from); + return jobRunStartTime.equals(jobRunStartTime) || jobRunStartTime.isAfter(beforeExecuteTime); + }); + + // Await JobDetailData.lastRunHistory [JobDetailHistoryData] jobRunEndTime to be both set and >= jobRunStartTime (or timeout) + Map finalLastRunHistory = await().atMost(TIMEOUT).pollInterval(PAUSE).until(jobLastRunHistorySupplier(jobId), lastRunHistory -> { + String jobRunEndText = lastRunHistory.get("jobRunEndTime"); + if (jobRunEndText == null) { + return false; + } + Instant jobRunEndTime = df.parse(jobRunEndText, Instant::from); + Instant jobRunStartTime = df.parse(lastRunHistory.get("jobRunStartTime"), Instant::from); + return jobRunEndTime.equals(jobRunStartTime) || jobRunEndTime.isAfter(jobRunStartTime); + }); + + // Verify triggerType + assertThat(finalLastRunHistory.get("triggerType"), is("application")); + + // Verify status & propagate jobRunErrorMessage and/or jobRunErrorLog (if any) + String status = finalLastRunHistory.get("status"); + if (!status.equals("success")) { + fail("Job status is not success: " + finalLastRunHistory.toString()); } + + // PS: Checking getSchedulerJobHistory() [/runhistory] is pointless, because the lastRunHistory JobDetailHistoryData is already part of JobDetailData anyway. + } + + @SuppressWarnings("unchecked") Review comment: As far as I can see, no, not easily unfortunately. Why? Vaguely related to what I blabbered on about in FINERACT-949 re. JSON mapping. I do want to think further about that some fine day, but not as part of this PR. OK to resolve this point? ########## File path: fineract-provider/src/integrationTest/java/org/apache/fineract/integrationtests/common/SchedulerJobHelper.java ########## @@ -122,45 +139,112 @@ private static String runSchedulerJobAsJSON() { return runSchedulerJob; } - public void executeJob(String jobName) throws InterruptedException { - List allSchedulerJobsData = getAllSchedulerJobs(); - Assert.assertNotNull(allSchedulerJobsData); - + private int getSchedulerJobIdByName(String jobName) { + List> allSchedulerJobsData = getAllSchedulerJobs(); for (Integer jobIndex = 0; jobIndex < allSchedulerJobsData.size(); jobIndex++) { if (allSchedulerJobsData.get(jobIndex).get("displayName").equals(jobName)) { - Integer jobId = (Integer) allSchedulerJobsData.get(jobIndex).get("jobId"); + return (Integer) allSchedulerJobsData.get(jobIndex).get("jobId"); + } + } + throw new IllegalArgumentException("No such named Job (see org.apache.fineract.infrastructure.jobs.service.JobName enum):" + jobName); + } - // Executing Scheduler Job - runSchedulerJob(this.requestSpec, jobId.toString()); + @Deprecated // FINERACT-922 TODO Gradually replace use of this method with new executeAndAwaitJob() below, if it proves to be more stable than this one Review comment: When I tried that while originally creating this, it didn't "just work" yet, so I wanted to get this in, and then more gradually attempt to "switch over", one by one, and further investigate related problems. Wanna help? :smiley_cat: OK to resolve this point? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: users@infra.apache.org