...
- Create java class that extends flexagon.fd.model.integration.its.api.IssueTrackingSystem. See example below.
- Below example has testConnection method implemented. The method uses the properties map to retrieve the configuration values to connect to the issue tracking system.
- In order to compile your java class, you will need FlexDeployAPI.jar on classpath.
- Implement all the methods descriped in the table in the API Implementation section
- For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");
- Once you are ready with unit testing, you can prepare Jar file for your credential store java class and other utility classes. This jar file can be placed on server classpath now.
- For Tomcat, put this jar file in apache-tomcat-flexdeploy/lib folder.
- For WebLogic, put this jar file in Domain lib folder.
- If you are using any third party libraries from your Java implementation, then those jar files will also need to be added to same lib folder. Keep in mind that this can cause issues with server functioning, so be prepared to remove your additional library files.
Groovy Implementation
Here are high level steps for Groovy implementation. You can use any IDE to prepare this implementation.
- Create a groovy class. See example below.
- Below example has testConnection method implemented.
...
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
package mycompany.extension.redmine.impl;
import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.client.filter.HTTPBasicAuthFilter;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import javax.ws.rs.core.Response;
import flexagon.fd.model.integration.its.api.IssueTrackingSystem;
import flexagon.fd.model.integration.its.api.Ticket;
import flexagon.fd.model.integration.util.ApiException;
public class RedmineServiceIntegration
extends IssueTrackingSystem
{
public RedmineServiceIntegration()
{
super();
}
@Override
public void checkConnection()
throws ApiException
{
String methodName = "checkConnection";
System.out.println(methodName + " getting version for project to check connection");
ClientResponse clientResponse = getWebResource("/projects/1/versions.json").get(ClientResponse.class);
System.out.println(methodName + String.format(" Successfully invoked test connection URL %s", clientResponse));
int statusCode = clientResponse.getStatusInfo().getStatusCode();
if (statusCode == 401)
{
throw new ApiException("Invalid credentials.", "");
}
if (!(clientResponse.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL))
{
throw new ApiException(clientResponse.getEntity(String.class), clientResponse.getStatusInfo().getReasonPhrase());
}
System.out.println(methodName + " Test connection response code looks valid, check content of response");
System.out.println(methodName + " Validated that JSON data was received from test connction URL invocation.");
}
private StringBuilder getRedmineURLBuilder()
{
StringBuilder urlBuilder = new StringBuilder((String) getProperties().get("REDMINE_URL"));
return urlBuilder;
}
private String getRedmineURL()
{
return getRedmineURLBuilder().toString();
}
private String getUserName()
{
return (String) getProperties().get("REDMINE_USER_NMAE");
}
private String getPassword()
{
return (String) getProperties().get("REDMINE_PASSWORD");
}
@Override
public void populateTicket(Ticket pTicket)
throws ApiException
{
// TODO Implement this method
}
@Override
public String getTicketURL(Ticket pTicket)
throws ApiException
{
// TODO Implement this method
return null;
}
@Override
public void addCommentToTicket(Ticket pTicket, String pString)
throws ApiException
{
// TODO Implement this method
}
@Override
public void changeTicketStatusTo(Ticket pTicket, String pString)
throws ApiException
{
// TODO Implement this method
}
@Override
public String getTicketStatus(Ticket pTicket)
throws ApiException
{
// TODO Implement this method
return null;
}
private Client getRestClient()
{
Client restClient = Client.create();
restClient.addFilter(new HTTPBasicAuthFilter(getUserName(), getPassword()));
restClient.setReadTimeout(20000);
restClient.setConnectTimeout(10000);
return restClient;
}
public WebResource getWebResource(String resource)
throws ApiException
{
String methodName = "getWebResource";
if (resource != null && !resource.isEmpty() && !resource.startsWith("/"))
{
resource += "/" + resource;
}
WebResource webResource = null;
try
{
webResource = getRestClient().resource(getRedmineURL()).path(resource);
}
catch (Exception e)
{
throw new ApiException(e.getMessage(), e.getMessage());
}
return webResource;
}
}
|
- In order to compile your java class, you will need FlexDeployAPI.jar on classpath.
- Implement all the methods descriped in the table in the API Implementation section
- For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");
- Once you are ready with unit testing, you can prepare Jar file for your credential store java class and other utility classes. This jar file can be placed on server classpath now.
- For Tomcat, put this jar file in apache-tomcat-flexdeploy/lib folder.
- For WebLogic, put this jar file in Domain lib folder.
- If you are using any third party libraries from your Java implementation, then those jar files will also need to be added to same lib folder. Keep in mind that this can cause issues with server functioning, so be prepared to remove your additional library files.
Groovy Implementation
Here are high level steps for Groovy implementation. You can use any IDE to prepare this implementation.
- Create a groovy class. See example below.
- Below example has testConnection and other methods implemented.
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
import flexagon.fd.model.integration.its.api.Ticket;
import flexagon.fd.model.integration.util.ApiException;
class RedmineIssueTrackingSystem
{
def checkConnection()
{
String methodName = "checkConnection()";
try
{
fdrestutils.testConnection(REDMINE_URL, "/projects/1/versions.json", REDMINE_USER_NMAE, REDMINE_PASSWORD)
}
catch (Exception e)
{
log.logInfo(methodName, " Failed in Test connection" + e.getMessage() + " " + e)
throw new ApiException("Connection failed. " + e.getMessage());
}
}
String getTicketStatus(Ticket ticket)
{
String methodName = "getTicketStatus()";
String message = " ticket# ${ticket.toString()}"
log.logInfo(methodName, message);
String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
javax.json.JsonObject jsonObj = fdrestutils.getRequest(REDMINE_URL, resourcePath, REDMINE_USER_NMAE, REDMINE_PASSWORD);
if(jsonObj != null)
{
javax.json.JsonObject issue = jsonObj.getJsonObject("issue")
if(issue!=null)
{
javax.json.JsonObject status = issue.getJsonObject("status")
if(status !=null)
{
return status.getString("name")
}
}
}
return null;
}
String getTicketURL(Ticket ticket)
{
String methodName = "getTicketURL()";
String message = "ticket# ${ticket.toString()}"
log.logInfo(methodName, message);
String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
message = "Redmine ticket URL is # ${REDMINE_URL}, resourcePath=${resourcePath}"
log.logInfo(methodName, message)
return REDMINE_URL + resourcePath;
}
def populateTicket(Ticket ticket)
{
String methodName = "populateTicket()";
String message = "Populate ticket# ${ticket.toString()}"
log.logInfo(methodName, message)
String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
javax.json.JsonObject jsonObj = fdrestutils.getRequest(REDMINE_URL, resourcePath, REDMINE_USER_NMAE, REDMINE_PASSWORD);
if(jsonObj != null)
{
javax.json.JsonObject issue = jsonObj.getJsonObject("issue")
if(issue!=null)
{
ticket.setDescription(issue.getString("description"))
javax.json.JsonObject tracker = issue.getJsonObject("tracker")
if(tracker !=null)
{
ticket.setType(tracker.getString("name"))
}
}
}
}
def addCommentToTicket(Ticket ticket, String pComment)
{
String methodName = "addCommentToTicket()";
try
{
String message = " Adding comment to ${ticket.toString()} , comment=${pComment}"
log.logInfo(methodName, message)
def builder = new groovy.json.JsonBuilder()
def root = builder.issue {
notes "${pComment}"
}
String payload = builder.toString();
String resourcePath = REDMINE_TICKET_REST_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
fdrestutils.putRequest(REDMINE_URL, REDMINE_USER_NMAE, REDMINE_PASSWORD, resourcePath, payload);
}
catch (Exception e)
{
log.logInfo( methodName, " Failed while adding comment to the issue - " + e.getMessage() + " " + e)
throw new ApiException("Connection failed. " + e.getMessage());
}
}
def changeTicketStatusTo(Ticket ticket, String pStatus)
{
String methodName = "changeTicketStatusTo()";
String message = " Adding comment to ${ticket.toString()} , status=${pStatus}"
log.logInfo(methodName, message)
def builder = new groovy.json.JsonBuilder()
def root = builder.issue {
notes "Status updated to ${pStatus}"
status_id "${pStatus}"
}
String payload = builder.toString();
String resourcePath = REDMINE_TICKET_REST_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
fdrestutils.putRequest(REDMINE_URL, REDMINE_USER_NMAE, REDMINE_PASSWORD, resourcePath, payload);
}
def parseTicketNumberFromChangeLogs(String pProjectName, List<String> pChangeLogMessages, List<String> pTicketPatternList)
{
String methodName = "parseTicketNumberFromChangeLogs()";
Set<String> ticketNumberList = HashSet<String>();
String message = " Input ProjectName= ${pProjectName}, ChangeLogMessages=${pChangeLogMessages} , TicketPatternList=${pTicketPatternList}"
log.logInfo(methodName, message)
if("Gradle".equals(pProjectName)) {
String[] patterns = ["ZZZ-"];
pTicketPatternList = Arrays.asList(patterns);
message = "override pattern for Gradle TicketPatternList=${pTicketPatternList}"
log.logInfo(methodName, message)
}
Collection<String> parsedTicketNumbers = flexagon.fd.model.integration.its.util.ChangeLogParser.getParser().parse(pChangeLogMessages, pTicketPatternList);
message = "parsedTicketNumbers=${parsedTicketNumbers}"
log.logInfo(methodName, message)
if(parsedTicketNumbers != null && !parsedTicketNumbers.isEmpty() && pTicketPatternList != null && !pTicketPatternList.isEmpty())
{
parsedTicketNumbers.each{ parsedTicket ->
pTicketPatternList.each{ pattern ->
if(parsedTicket.startsWith(pattern))
{
String ticketNumber = parsedTicket.substring(pattern.length(),parsedTicket.length())
ticketNumberList.add(ticketNumber)
}
}
}
}
return ticketNumberList;
}
} |
- Implement all the methods descriped in the table in the API Implementation section
- For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");
...