buildSrc/src/main/java/cc/squirreljme/plugin/multivm/VMTestParameters.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.multivm;
  11
  12 import java.io.Serializable;
  13 import org.gradle.api.file.RegularFileProperty;
  14 import org.gradle.api.provider.ListProperty;
  15 import org.gradle.api.provider.Property;
  16 import org.gradle.workers.WorkParameters;
  17
  18 /**
  19  * This contains the parameters for work units, which are used to divide and
  20  * execute the actual work.
  21  *
  22  * @since 2020/09/06
  23  */
  24 public interface VMTestParameters
  25         extends WorkParameters
  26 {
  27         /**
  28          * Returns the command line to be executed.
  29          *
  30          * @return The command line to execute.
  31          * @since 2020/09/07
  32          */
  33         ListProperty<String> getCommandLine();
  34
  35         /**
  36          * The current test count.
  37          *
  38          * @return The current test count.
  39          * @since 2020/09/07
  40          */
  41         Property<Integer> getCount();
  42
  43         /**
  44          * Returns the result of the test.
  45          *
  46          * @return The result of the test.
  47          * @since 2020/09/06
  48          */
  49         RegularFileProperty getResultFile();
  50
  51         /**
  52          * The test to be run.
  53          *
  54          * @return The test to be ran.
  55          * @since 2020/09/06
  56          */
  57         Property<String> getTestName();
  58
  59         /**
  60          * The total number of tests.
  61          *
  62          * @return The test total.
  63          * @since 2020/09/07
  64          */
  65         Property<Integer> getTotal();
  66
  67         /**
  68          * Returns the virtual machine name.
  69          *
  70          * @return The virtual machine name.
  71          * @since 2020/09/07
  72          */
  73         Property<String> getVmName();
  74
  75         /**
  76          * Returns the unique ID of the task run.
  77          *
  78          * @return The unique ID of the task run.
  79          * @since 2022/07/01
  80          */
  81         Property<String> getUniqueId();
  82 }