Package com.atlassian.jira.functest.framework.backdoor

Class ChartsControl

java.lang.Object
com.atlassian.jira.testkit.client.RestApiClient<T>
com.atlassian.jira.testkit.client.BackdoorControl<T>
com.atlassian.jira.functest.framework.backdoor.BackdoorControl<ChartsControl>
com.atlassian.jira.functest.framework.backdoor.ChartsControl
public class ChartsControl extends BackdoorControl<ChartsControl>

  • Constructor Details

    • ChartsControl

      public ChartsControl(com.atlassian.jira.testkit.client.JIRAEnvironmentData environmentData)

  • Method Details

    • generateResolutionTimeChart

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<ResolutionTimeData> generateResolutionTimeChart(String queryString, int days, String endDate, ChartFactory.PeriodName periodName)
      Generates the Resolution Time Chart based on Date Range Time Chart. Displays a bar graph of elapsed time to resolve issues for a project or filter.
      Parameters:
      queryString - - a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
      days - - The number of days previous to go back for. Must be positive.
      endDate - - The end date for the chart. Must be in the format compliant with JQL date search. Valid formats include: yyyy/MM/dd HH:mm, yyyy-MM-dd HH:mm, yyyy/MM/dd, yyyy-MM-dd, or a period format, for example -5d, 4w 2d
      periodName - - The name of the period. See - ChartFactory.PeriodName
      Returns:
      a ParsedResponse with a ResolutionTimeData

    • generateRecentlyCreatedChart

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<RecentlyCreatedData> generateRecentlyCreatedChart(String queryString, int days, String endDate, ChartFactory.PeriodName periodName)
      Generates the Recently Created Chart. Displays recently created issues for a specified project as a bar chart
      Parameters:
      queryString - - a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
      days - - The number of days previous to go back for. Must be positive.
      endDate - - The end date for the chart. Must be in the format compliant with JQL date search. Valid formats include: yyyy/MM/dd HH:mm, yyyy-MM-dd HH:mm, yyyy/MM/dd, yyyy-MM-dd, or a period format, for example -5d, 4w 2d
      periodName - - The name of the period. See - ChartFactory.PeriodName
      Returns:
      a ParsedResponse with a RecentlyCreatedData

    • generateTimeSinceChart

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<TimeSinceData> generateTimeSinceChart(String queryString, int days, String dateField, String endDate, ChartFactory.PeriodName periodName, boolean isCumulative)
      Generates the Time Since Chart. Displays the time since a chosen field date for each issue for a project or saved filter.
      Parameters:
      queryString - - a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
      days - - The number of days previous to go back for. Must be positive.
      dateField - - The date field to use for the chart. Must be a valid date field. By default, it is set to "created".
      endDate - - The end date for the chart. Must be in the format compliant with JQL date search. Valid formats include: yyyy/MM/dd HH:mm, yyyy-MM-dd HH:mm, yyyy/MM/dd, yyyy-MM-dd, or a period format, for example -5d, 4w 2d
      periodName - - The name of the period. See - ChartFactory.PeriodName
      isCumulative - - If true, the chart will be cumulative, otherwise it will be non-cumulative.
      Returns:
      a ParsedResponse with a TimeSinceData

    • generateTimeSinceChart

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<TimeSinceData> generateTimeSinceChart(String queryString, int days, String endDate, ChartFactory.PeriodName periodName, boolean isCumulative)

    • generateCreatedVsResolvedChart

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<CreatedVsResolvedData> generateCreatedVsResolvedChart(String queryString, int days, String endDate, ChartFactory.PeriodName periodName, boolean isCumulative, boolean showUnresolvedTrend)
      Generates the Created vs Resolved Chart. Displays a line graph showing the difference between created and resolved issues over time.
      Parameters:
      queryString - - a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
      days - - The number of days previous to go back for. Must be positive.
      endDate - - The end date for the chart. Must be in the format compliant with JQL date search. Valid formats include: yyyy/MM/dd HH:mm, yyyy-MM-dd HH:mm, yyyy/MM/dd, yyyy-MM-dd, or a period format, for example -5d, 4w 2d
      periodName - - The name of the period. See - ChartFactory.PeriodName
      isCumulative - - Whether to show cumulative totals
      showUnresolvedTrend - - Whether to show trend of unresolved issues
      Returns:
      a ParsedResponse with a CreatedVsResolvedData

    • generateTwoDimensionalStats

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<TwoDimensionalStatsData> generateTwoDimensionalStats(String queryString, String xStatType, String yStatType, ChartsControl.SortDirection sortDirection, ChartsControl.SortingOrderType sortingOrderType, String yAxisValuesLimit)
      Generates the Two Dimensional Stats. Displays a two-dimensional matrix of statistics for a given filter.
      Parameters:
      queryString - - a filter id (starts with "filter-", and ends with the filter ID)
      xStatType - - The type of statistic to display on the x-axis. Must be a valid statistic type.
      yStatType - - The type of statistic to display on the y-axis. Must be a valid statistic type.
      sortDirection - - The direction to sort the statistics. Must be "asc" or "desc".
      sortingOrderType - - The type of sorting. Can be "natural" for sorting by value or "total" for sorting by total.
      yAxisValuesLimit - - The number of statistics to show on the y-axis. Must be positive.
      Returns:
      a ParsedResponse with a Object

    • generateAverageAgeChart

      public com.atlassian.jira.testkit.client.restclient.ParsedResponse<AverageAgeData> generateAverageAgeChart(String queryString, int days, String endDate, ChartFactory.PeriodName periodName)
      Generates the Average Age Chart. Displays the average age of issues over time for a project or filter.
      Parameters:
      queryString - - a filter id (starts with "filter-") or project id (starts with "project-") or jql (starts with "jql-")
      days - - The number of days previous to go back for. Must be positive.
      endDate - - The end date for the chart. Must be in the format compliant with JQL date search. Valid formats include: yyyy/MM/dd HH:mm, yyyy-MM-dd HH:mm, yyyy/MM/dd, yyyy-MM-dd, or a period format, for example -5d, 4w 2d
      periodName - - The name of the period. See - ChartFactory.PeriodName
      Returns:
      a ParsedResponse with a AverageAgeData

    • resolutionTimeChart

      protected javax.ws.rs.client.WebTarget resolutionTimeChart(String queryString, String days, String endDate, String periodName)

    • recentlyCreatedChart

      protected javax.ws.rs.client.WebTarget recentlyCreatedChart(String queryString, String days, String endDate, String periodName)

    • timeSinceChart

      protected javax.ws.rs.client.WebTarget timeSinceChart(String queryString, String days, String endDate, String periodName, boolean isCumulative)

    • createdVsResolvedChart

      protected javax.ws.rs.client.WebTarget createdVsResolvedChart(String queryString, String days, String endDate, String periodName, boolean isCumulative, boolean showUnresolvedTrend)

    • averageAgeChart

      protected javax.ws.rs.client.WebTarget averageAgeChart(String queryString, String days, String endDate, String periodName)