Apache Ignite Developers - Legacy Mail Archive

[GitHub] asfgit closed pull request #88: IGNITE-10519 JavaDocs added

Classic

List

Threaded

1 message

GitBox

[GitHub] asfgit closed pull request #88: IGNITE-10519 JavaDocs added

asfgit closed pull request #88: IGNITE-10519 JavaDocs added
URL: https://github.com/apache/ignite-teamcity-bot/pull/88

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/observer/BuildsInfo.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/observer/BuildsInfo.java
index 40e33011..00e74bf0 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/observer/BuildsInfo.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/observer/BuildsInfo.java
@@ -30,16 +30,21 @@
import org.apache.ignite.ci.web.model.ContributionKey;

/**
- *
+ * Represents parameters to determine context of rerunned builds, list of build IDs
+ * which were requested to rerun and provides methods to check status of
+ * rerunned builds.
*/
public class BuildsInfo {
- /** */
+ /** Shows that all rerunned builds finished successfully. */
public static final String FINISHED_STATUS = "finished";

- /** */
+ /** Shows that some rerunned builds is not finished. */
public static final String RUNNING_STATUS = "running";

- /** */
+ /**
+ * Shows that one or more rerunned builds were cancelled or have UNKNOWN
+ * status on TC for some other reasons.
+ */
public static final String CANCELLED_STATUS = "cancelled";

/** */
@@ -95,6 +100,9 @@ public BuildsInfo(String srvId, ICredentialsProv prov, String ticket, String bra

/**
* @param teamcity Teamcity.
+ *
+ * @return One of {@link FINISHED_STATUS}, {@link CANCELLED_STATUS} or
+ * {@link RUNNING_STATUS} statuses.
*/
public String getStatus(IAnalyticsEnabledTeamcity teamcity) {
boolean isFinished = true;
diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/ContributionKey.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/ContributionKey.java
index 89e14d2b..2e2c6b2a 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/ContributionKey.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/ContributionKey.java
@@ -21,7 +21,7 @@
import org.apache.ignite.ci.teamcity.ignited.IStringCompactor;

/**
- *
+ * Class which is used as a key to determine Server and TC branch info.
*/
public class ContributionKey {
/** */
diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/JiraCommentResponse.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/JiraCommentResponse.java
index 26bde0ae..886e2703 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/JiraCommentResponse.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/JiraCommentResponse.java
@@ -20,7 +20,7 @@
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

/**
- *
+ * Representation of responce which was recieved after Jira commenting request.
*/
@JsonIgnoreProperties(ignoreUnknown = true)
public class JiraCommentResponse {
diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/Visa.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/Visa.java
index e826cc4e..a331586e 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/Visa.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/Visa.java
@@ -21,10 +21,12 @@
import org.jetbrains.annotations.Nullable;

/**
- *
+ * Representation of TC Bot visa - comment in apache Jira ticket conversation
+ * which shows a list of tests which probably failed because of committed
+ * changes(blockers) based on TC Run-All results.
*/
public class Visa {
- /** */
+ /** Determines Visa with no results and info. */
public static final String EMPTY_VISA_STATUS = "emptyVisa";

/** */
@@ -36,7 +38,9 @@
/** */
public final int blockers;

- /** */
+ /**
+ * @return instance of {@link Visa} with {@link EMPTY_VISA_STATUS}
+ */
public static Visa emptyVisa() {
return new Visa(EMPTY_VISA_STATUS);
}
diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/VisaRequest.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/VisaRequest.java
index 74839281..8ca93fff 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/VisaRequest.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/VisaRequest.java
@@ -21,19 +21,26 @@
import org.jetbrains.annotations.Nullable;

/**
- *
+ * Representation of visa request from TC Bot. Visa request can be with
+ * additional builds rerun and without them. So it is used for tracking
+ * rerunned builds status and storing resulting visa.
*/
public class VisaRequest {
- /** */
+ /** Common information to determine visa request */
private BuildsInfo info;

- /** */
+ /** Result of request. */
private Visa visa;

- /** */
+ /**
+ * Flag which is used to show that some outer services monitor the status
+ * of rerunned builds which are not finished yet.
+ */
private boolean isObserving;

- /** */
+ /**
+ * @param info Common information to determine visa request.
+ */
public VisaRequest(BuildsInfo info) {
this.info = info;
this.visa = Visa.emptyVisa();
diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/BuildsHistory.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/BuildsHistory.java
index de7a0d1f..4ac0a2fa 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/BuildsHistory.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/BuildsHistory.java
@@ -44,7 +44,13 @@
import static com.google.common.base.Strings.isNullOrEmpty;

/**
- * Builds History: includes statistic for every build and merged failed unmuted tests in specified time interval.
+ * Presents statistic for all valid builds and merged failed unmuted tests in
+ * specified time interval. Statistics and tests are stored in
+ * {@link buildsStatistics} and {@link mergedTestsBySuites} properties
+ * respectively. Builder pattern is used for instance creation.
+ * Default values: skipTests = false, projectId="IgniteTests24Java8",
+ * srvId="apache", buildTypeId="IgniteTests24Java8_RunAll",
+ * branchName="refs/heads/master".
*/
public class BuildsHistory {
/** */
@@ -73,7 +79,7 @@
/** */
private boolean skipTests;

- /** */
+ /** Build statistics for all valid builds in specified time interval. */
public List<BuildStatisticsSummary> buildsStatistics = new ArrayList<>();

/** */
@@ -86,7 +92,12 @@
@Inject private IStringCompactor compactor;

- /** */
+ /**
+ * Initialize {@link mergedTestsBySuites} and {@link buildsStatistics}
+ * properties using builds which satisfy properties setted by Builder.
+ *
+ * @param prov Credentials.
+ */
public void initialize(ICredentialsProv prov) {
ITeamcityIgnited ignitedTeamcity = tcIgnitedProv.server(srvId, prov);

@@ -114,7 +125,13 @@ public void initialize(ICredentialsProv prov) {
System.out.println("Preparing response");
}

- /** */
+ /**
+ * Initialize {@link buildsStatistics} property with list of {@link BuildStatisticsSummary}
+ * produced for each valid build.
+ *
+ * @param ignited {@link ITeamcityIgnited} instance.
+ * @param buildIdsWithConditions Build ID -> build validation flag.
+ */
private void initStatistics(ITeamcityIgnited ignited,
Map<Integer, Boolean> buildIdsWithConditions) {
List<Future<BuildStatisticsSummary>> buildStaticsFutures = new ArrayList<>();
@@ -153,7 +170,13 @@ private void initStatistics(ITeamcityIgnited ignited,
});
}

- /** */
+ /**
+ * Initialize {@link mergedTestsBySuites} property by unique failed tests
+ * which occured in specified date interval.
+ *
+ * @param buildIds list of valid builds.
+ * @param buildIdsWithConditions Build ID -> build validation flag.
+ */
private void initFailedTests(List<Integer> buildIds,
Map<Integer, Boolean> buildIdsWithConditions) {

@@ -222,7 +245,9 @@ private BuildsHistory withParameters(Builder builder) {
/** */
private DateFormat dateFormat = new SimpleDateFormat("ddMMyyyyHHmmss");

- /** */
+ /**
+ * @param srvId server name.
+ */
public Builder server(String srvId) {
if (!isNullOrEmpty(srvId))
this.srvId = srvId;
@@ -230,7 +255,9 @@ public Builder server(String srvId) {
return this;
}

- /** */
+ /**
+ * @param buildType TC suite(buildType) name.
+ */
public Builder buildType(String buildType) {
if (!isNullOrEmpty(buildType))
this.buildTypeId = buildType;
@@ -238,7 +265,9 @@ public Builder buildType(String buildType) {
return this;
}

- /** */
+ /**
+ * @param projectId TC project name.
+ */
public Builder project(String projectId) {
if (!isNullOrEmpty(projectId))
this.projectId = projectId;
@@ -246,7 +275,9 @@ public Builder project(String projectId) {
return this;
}

- /** */
+ /**
+ * @param branchName TC branch name.
+ */
public Builder branch(String branchName) {
if (!isNullOrEmpty(branchName))
this.branchName = branchName;
@@ -254,7 +285,10 @@ public Builder branch(String branchName) {
return this;
}

- /** */
+ /**
+ * @param sinceDate left border of date interval form which builds
+ * will be presented.
+ */
public Builder sinceDate(String sinceDate) throws ParseException {
if (!isNullOrEmpty(sinceDate))
this.sinceDate = dateFormat.parse(sinceDate);
@@ -262,7 +296,10 @@ public Builder sinceDate(String sinceDate) throws ParseException {
return this;
}

- /** */
+ /**
+ * @param untilDate right border of date interval form which builds
+ * will be presented.
+ */
public Builder untilDate(String untilDate) throws ParseException {
if (!isNullOrEmpty(untilDate))
this.untilDate = dateFormat.parse(untilDate);
@@ -270,7 +307,7 @@ public Builder untilDate(String untilDate) throws ParseException {
return this;
}

- /** */
+ /** Set flag to skip collection of failed tests info. */
public Builder skipTests() {
this.skipTests = true;

@@ -279,7 +316,8 @@ public Builder skipTests() {

/**
- * @param injector */
+ * @param injector Guice instance for dependency injection.
+ */
public BuildsHistory build(Injector injector) {
final BuildsHistory instance = injector.getInstance(BuildsHistory.class);

diff --git a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/VisasHistoryStorage.java b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/VisasHistoryStorage.java
index 623d42dc..b7adba9f 100644
--- a/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/VisasHistoryStorage.java
+++ b/ignite-tc-helper-web/src/main/java/org/apache/ignite/ci/web/model/hist/VisasHistoryStorage.java
@@ -35,10 +35,11 @@
import org.apache.ignite.ci.web.model.VisaRequest;

/**
- *
+ * Storage which contains {@link VisaRequest} sorted by
+ * {@link CompactContributionKey}, and stored in order of addition.
*/
public class VisasHistoryStorage {
- /** */
+ /** Cache name. */
public static final String VISAS_CACHE_NAME = "compactVisasHistoryCacheV2";

/** */
@@ -49,17 +50,19 @@
@Inject
private Ignite ignite;

- /** */
+ /** Clear cache. */
public void clear() {
visas().clear();
}

- /** */
+ /**
+ * @return Instance of cache.
+ */
public Cache<CompactContributionKey, List<CompactVisaRequest>> visas() {
return ignite.getOrCreateCache(TcHelperDb.getCacheV3TxConfig(VISAS_CACHE_NAME));
}

- /** */
+ /** Put visa request to cache. */
public void put(VisaRequest visaReq) {
CompactVisaRequest compactVisaReq = new CompactVisaRequest(visaReq, strCompactor);

@@ -81,7 +84,11 @@ public void put(VisaRequest visaReq) {
});
}

- /** */
+ /**
+ * @param key {@link ContributionKey} instance.
+ *
+ * @return list of all {@link VisaRequest} for specified key.
+ */
public List<VisaRequest> getVisaRequests(ContributionKey key) {
List<CompactVisaRequest> reqs = visas().get(new CompactContributionKey(key, strCompactor));

@@ -93,7 +100,10 @@ public void put(VisaRequest visaReq) {
.collect(Collectors.toList());
}

- /** */
+ /**
+ * @param key {@link ContributionKey} instance.
+ *
+ * @return Last added {@link VisaRequest} for specified key. */
public VisaRequest getLastVisaRequest(ContributionKey key) {
List<VisaRequest> reqs = getVisaRequests(key);

@@ -103,7 +113,12 @@ public VisaRequest getLastVisaRequest(ContributionKey key) {
return reqs.get(reqs.size() - 1);
}

- /** */
+ /**
+ * @param key {@link ContributionKey} instance.
+ * @param updater {@link Consumer<VisaRequest>} which will be applied to last Visa request for specified key.
+ *
+ * @return {@link True} if specified key exists.
+ */
public boolean updateLastVisaRequest(ContributionKey key, Consumer<VisaRequest> updater) {
CompactContributionKey compactKey = new CompactContributionKey(key, strCompactor);

@@ -129,7 +144,9 @@ public boolean updateLastVisaRequest(ContributionKey key, Consumer<VisaRequest>
return true;
}

- /** */
+ /**
+ * @return Collection of last {@link VisaRequest} for every stored key.
+ */
public Collection<VisaRequest> getLastVisas() {
List<VisaRequest> res = new ArrayList<>();

@@ -142,7 +159,9 @@ public boolean updateLastVisaRequest(ContributionKey key, Consumer<VisaRequest>
return Collections.unmodifiableCollection(res);
}

- /** */
+ /**
+ * @return Collection of all {@link VisaRequest} for every stored key.
+ */
public Collection<VisaRequest> getVisas() {
List<VisaRequest> res = new ArrayList<>();

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[hidden email]

With regards,
Apache Git Services