Package io.jenkins.plugins.railflow

Interface UploadParameters

All Superinterfaces:
Serializable
All Known Implementing Classes:
UploadParametersImpl
public interface UploadParameters extends Serializable
Contains basic parameters required for any type of upload.
Author:
Liu Yang, Sergey Oplavin

  • Method Details

    • builder

      static UploadParameters.Builder builder(String railFlowProject, String testPath, ReportFormat reportFormat, SearchMode searchMode)
      New builder.
      Parameters:
      railFlowProject - railflow project name.
      testPath - test path, e.g. 'Master/Section'.
      reportFormat - report format.
      Returns:
      builder.

    • getProject

      @NonNull String getProject()
      Gets the project name.
      Returns:
      the project name

    • getTestPath

      @NonNull String getTestPath()
      Gets the test path.
      Returns:
      the test path

    • getReportFormat

      @NonNull ReportFormat getReportFormat()
      Gets the testreport format.
      Returns:
      the testreport format

    • getSearchMode

      @NonNull SearchMode getSearchMode()
      Returns:
      specifies the test case lookup algorithm.

    • getTestRun

      Optional<String> getTestRun()
      Gets the test run.
      Returns:
      the test run

    • getTestPlan

      Optional<String> getTestPlan()
      Gets the test plan.
      Returns:
      the test plan

    • getMilestonePath

      Optional<String> getMilestonePath()
      Gets the milestone path.
      Returns:
      the milestone path

    • getCaseFields

      Optional<Map<String,Object>> getCaseFields()
      Gets the case fields.
      Returns:
      the case fields

    • getResultFields

      Optional<Map<String,Object>> getResultFields()
      Gets the result fields.
      Returns:
      the result fields

    • getConfigNames

      Optional<List<String>> getConfigNames()
      Returns:
      string list containing configuration names (paths)

    • isCloseRun

      boolean isCloseRun()
      Checks if is close run.
      Returns:
      true, if is close run.

    • isClosePlan

      boolean isClosePlan()
      Checks if is close plan.
      Returns:
      true, if is close plan.

    • getCaseNameToIdMap

      Optional<Map<String,Integer>> getCaseNameToIdMap()
      Returns:
      string containing mappings between test name and test case ID in TestRail.

    • isDisableGrouping

      boolean isDisableGrouping()
      Returns:
      flag indicates whether or not sub section creation (grouping) is disabled. true - creation of subsections is disabled so all test cases will be uploaded into one section defined by test path parameter, false - creation of subsection is enabled, so one or more subsection will be created.

    • getTemplateName

      Optional<String> getTemplateName()
      Gets the template name.
      Returns:
      the template name

    • getCaseType

      Optional<String> getCaseType()
      Gets the case type.
      Returns:
      the case type

    • getCasePriority

      Optional<String> getCasePriority()
      Gets the case priority.
      Returns:
      the case priority

    • getRunId

      Optional<RunId> getRunId()
      Returns:
      the ID of the TestRail Run to update or 0.

    • getUploadMode

      Optional<UploadMode> getUploadMode()
      Returns:
      specifies test cases upload mode.

    • getSmartTestFailureAssignment

      Optional<List<String>> getSmartTestFailureAssignment()
      Returns:
      string list of user email addresses.

    • getCaseSearchField

      Optional<String> getCaseSearchField()
      Gets the name of the case filed in TestRail which will be using for searching for existing test cases instead of test case title.
      Returns:
      the name of a case field.

    • isFullCaseNamesAllowed

      boolean isFullCaseNamesAllowed()
      Checks if full case names allowed for test case names.
      Returns:
      true, if full case names allowed.

    • getTagsFieldName

      Optional<String> getTagsFieldName()
      Gets the tags field name.
      Returns:
      the tags field name.