Java tutorial
/******************************************************************************* * Copyright (c) 2011 Coverity, Inc * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * Coverity, Inc - initial implementation and documentation *******************************************************************************/ package jenkins.plugins.coverity; import com.coverity.ws.v6.*; import com.coverity.ws.v9.DefectStateAttributeValueDataObj; import hudson.Util; import hudson.model.Descriptor; import hudson.model.Hudson; import hudson.util.ListBoxModel; import org.apache.commons.lang.StringUtils; import org.kohsuke.stapler.DataBoundConstructor; import hudson.model.BuildListener; import javax.xml.datatype.DatatypeFactory; import javax.xml.datatype.XMLGregorianCalendar; import java.io.IOException; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.*; /** * Responsible for filtering the full list of defects to determine if a build should fail or not. Filters are inclusive: * a defect needs to pass every filter in order to be included. */ public class DefectFilters { private List<String> classifications; private List<String> actions; private List<String> severities; private List<String> components; private List<String> checkers; private List<String> ignoredCheckers; private Date cutOffDate; private Map<String, String> impactMap; private List<String> impacts; @DataBoundConstructor public DefectFilters(List<String> actions, List<String> impacts, List<String> classifications, List<String> severities, List<String> components, List<String> checkers, String cutOffDate) throws Descriptor.FormException { this.classifications = Util.fixNull(classifications); this.actions = Util.fixNull(actions); this.impacts = Util.fixNull(impacts); this.severities = Util.fixNull(severities); this.components = Util.fixNull(components); this.checkers = Util.fixNull(checkers); this.ignoredCheckers = new ArrayList<String>(); cutOffDate = Util.fixEmpty(cutOffDate); if (cutOffDate != null) { try { this.cutOffDate = new SimpleDateFormat("yyyy-MM-dd").parse(cutOffDate); } catch (ParseException e) { this.cutOffDate = null; } } else { this.cutOffDate = null; } } void invertCheckers(Set<String> allCheckers, List<String> allClassifications, List<String> allActions, List<String> allSeverities, List<String> allComponents) { if (classifications.isEmpty() && checkers.isEmpty() && actions.isEmpty() && components.isEmpty() && severities.isEmpty()) { ignoredCheckers = new ArrayList<String>(); actions = allActions; severities = allSeverities; components = allComponents; classifications = allClassifications; } else { ignoredCheckers = new ArrayList<String>(allCheckers); ignoredCheckers.removeAll(checkers); } } /** * We want to do a check on the defect configuration so that no null values are going into the build. * There has been issues on upgrade where configurations are changed, and not updates thus causing builds to * fail because some configuaritons are null. * @return true if defect configurations are not null */ public boolean checkConfig() { if (this.getCheckersList() == null || this.getClassifications() == null || this.getActions() == null || this.getSeverities() == null || this.getComponents() == null) { return false; } return true; } public boolean isClassificationSelected(String action) { return classifications.contains(action); } public List<String> getCheckersList() { return checkers; } public boolean isActionSelected(String action) { return actions.contains(action); } public boolean isImpactsSelected(String impact) { Map<String, String> mapWithJapaneseTranslations; mapWithJapaneseTranslations = new HashMap<String, String>(); mapWithJapaneseTranslations.put("High", ""); mapWithJapaneseTranslations.put("Medium", ""); mapWithJapaneseTranslations.put("Low", ""); List<String> initialImpacts = new ArrayList<String>(this.impacts); if (initialImpacts != null && !initialImpacts.isEmpty()) { for (String specificImpact : initialImpacts) { if (mapWithJapaneseTranslations.containsKey(specificImpact)) { this.impacts.add(mapWithJapaneseTranslations.get(specificImpact)); } } } return impacts.contains(impact); } public boolean isSeveritySelected(String severity) { return severities.contains(severity); } public boolean isComponentSelected(String component) { return components.contains(component); } public boolean isCheckerSelected(String checker) { if (ignoredCheckers == null) { return false; } return !ignoredCheckers.contains(checker); } public String getCutOffDate() { if (cutOffDate == null) return null; return new SimpleDateFormat("yyyy-MM-dd").format(cutOffDate); } public List<String> getClassifications() { return classifications; } public List<String> getActions() { return actions; } public List<String> getSeverities() { return severities; } public List<String> getImpacts() { return impacts; } public List<ComponentIdDataObj> getComponents() { List<ComponentIdDataObj> componentIdDataList = new ArrayList<ComponentIdDataObj>(); for (String comp : components) { ComponentIdDataObj cIdDataObj = new ComponentIdDataObj(); cIdDataObj.setName(comp); componentIdDataList.add(cIdDataObj); } return componentIdDataList; } public List<CheckerSubcategoryFilterSpecDataObj> getCheckers(BuildListener listener) { List<CheckerSubcategoryFilterSpecDataObj> checkerSubFilterSpecDataObjList = new ArrayList<CheckerSubcategoryFilterSpecDataObj>(); for (String check : checkers) { if (check != null) { CheckerSubcategoryFilterSpecDataObj checkerSubFilterSpecDataObj = new CheckerSubcategoryFilterSpecDataObj(); checkerSubFilterSpecDataObj.setCheckerName(check); checkerSubFilterSpecDataObjList.add(checkerSubFilterSpecDataObj); } } return checkerSubFilterSpecDataObjList; } public List<String> getIgnoredChecker() { return ignoredCheckers; } public XMLGregorianCalendar getXMLCutOffDate() { GregorianCalendar calender = new GregorianCalendar(); calender.setTime(cutOffDate); try { return DatatypeFactory.newInstance().newXMLGregorianCalendar(calender); } catch (Exception e) { } return null; } /* createImpactMap Creates an impact map with a key that is based upon the Checkername:Domain:Subcategory. We use that as the key because it can be easily obtained from the mergedDefectDataObj and can be tied to the CheckerSubcategoryDataObj since that contains the impact. That map is then stored within DefectFilters which it will later use to filter defects. */ public void createImpactMap(CIMInstance cim) { this.impactMap = new HashMap<String, String>(); try { // Setting up the ws call to get all CheckerSubcategory for the current project ConfigurationService configurationService = cim.getConfigurationService(); CheckerPropertyFilterSpecDataObj checkerPropFilter = new CheckerPropertyFilterSpecDataObj(); List<CheckerPropertyDataObj> checkerPropertyList = configurationService .getCheckerProperties(checkerPropFilter); // Going through each CheckerSubcategory to get the ID object, which contains the Checker name, domain and Subcategory information for (CheckerPropertyDataObj checkerProp : checkerPropertyList) { // Make sure we save the impact String impact = checkerProp.getImpact(); CheckerSubcategoryIdDataObj checkerSub = checkerProp.getCheckerSubcategoryId(); // Creating the key based on the format of CheckerName:Domain:Subcategory String key = String.format("%s:%s:%s", checkerSub.getCheckerName(), checkerSub.getDomain(), checkerSub.getSubcategory()); impactMap.put(key, impact); } } catch (Exception e) { // We dont to do anything if this fails since it happens so late within the build. } } /* checkImpactSelected The function is used to see if the mergeDefect that is passed in has a impact that matches with the impacts selected within the configuration. */ public boolean checkImpactSelected(MergedDefectDataObj defect) { // Creating the key with a specific format. CheckerName:Domain:CheckerSubcategory String key = String.format("%s:%s:%s", defect.getCheckerName(), defect.getDomain(), defect.getCheckerSubcategory()); // if a checker does not have a impact, we let it through since the impact is undetermined. if (!this.impactMap.containsKey(key)) { return true; } if (this.impacts != null && this.impactMap != null) { // Go through the impacts map that will have the key associated with an impact. for (String selectedImpact : this.impacts) { if (selectedImpact != null) { if (this.impactMap.get(key).equals(selectedImpact)) { return true; } } } } return false; } public boolean matches(MergedDefectDataObj defect, BuildListener listener) { return isActionSelected(defect.getAction()) && isClassificationSelected(defect.getClassification()) && isSeveritySelected(defect.getSeverity()) && isComponentSelected(defect.getComponentName()) && isCheckerSelected(defect.getCheckerName()) && checkImpactSelected(defect) && Arrays.asList("New", "Triaged", "Various").contains(defect.getStatus()) && (cutOffDate == null || defect.getFirstDetected().toGregorianCalendar().getTime().after(cutOffDate)); } public boolean matchesIndio(com.coverity.ws.v9.MergedDefectDataObj defect, BuildListener listener) { String status = ""; String action = ""; String classification = ""; String severity = ""; List<DefectStateAttributeValueDataObj> listOfAttributes = defect.getDefectStateAttributeValues(); for (DefectStateAttributeValueDataObj defectAttribute : listOfAttributes) { if (defectAttribute.getAttributeDefinitionId().getName().equals("DefectStatus")) { status = defectAttribute.getAttributeValueId().getName(); } if (defectAttribute.getAttributeDefinitionId().getName().equals("Action")) { action = defectAttribute.getAttributeValueId().getName(); } if (defectAttribute.getAttributeDefinitionId().getName().equals("Classification")) { classification = defectAttribute.getAttributeValueId().getName(); } if (defectAttribute.getAttributeDefinitionId().getName().equals("Severity")) { severity = defectAttribute.getAttributeValueId().getName(); } } return isActionSelected(action) && isClassificationSelected(classification) && isSeveritySelected(severity) && isComponentSelected(defect.getComponentName()) && isCheckerSelected(defect.getCheckerName()) && isImpactsSelected(defect.getDisplayImpact()) && Arrays.asList("New", "Triaged", "Various").contains(status) && (cutOffDate == null || defect.getFirstDetected().toGregorianCalendar().getTime().after(cutOffDate)); } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; DefectFilters that = (DefectFilters) o; if (actions != null ? !actions.equals(that.actions) : that.actions != null) return false; if (checkers != null ? !checkers.equals(that.checkers) : that.checkers != null) return false; if (classifications != null ? !classifications.equals(that.classifications) : that.classifications != null) return false; if (components != null ? !components.equals(that.components) : that.components != null) return false; if (cutOffDate != null ? !cutOffDate.equals(that.cutOffDate) : that.cutOffDate != null) return false; if (severities != null ? !severities.equals(that.severities) : that.severities != null) return false; return true; } @Override public int hashCode() { int result = classifications != null ? classifications.hashCode() : 0; result = 31 * result + (actions != null ? actions.hashCode() : 0); result = 31 * result + (severities != null ? severities.hashCode() : 0); result = 31 * result + (components != null ? components.hashCode() : 0); result = 31 * result + (checkers != null ? checkers.hashCode() : 0); result = 31 * result + (cutOffDate != null ? cutOffDate.hashCode() : 0); return result; } public CoverityPublisher.DescriptorImpl getPublisherDescriptor() { return Hudson.getInstance().getDescriptorByType(CoverityPublisher.DescriptorImpl.class); } /** * Set checkers is used when specific jenkins instances are set up with pre-exisiting configurations and we need to * reset the checkers. (Mainly because of STS) * @param cimInstance * @param streamId * @throws IOException * @throws CovRemoteServiceException_Exception */ public void setCheckers(CIMInstance cimInstance, long streamId) throws IOException, CovRemoteServiceException_Exception { String wsversion = cimInstance.getWsVersion(); try { if (wsversion.equals("v9")) { // Retrieve all defects for a specific cim instance. String cs = cimInstance.getCimInstanceCheckers(); checkers = getPublisherDescriptor().split2List(cs); } else { StreamDataObj stream = getStream(String.valueOf(streamId), cimInstance); String type = stream.getLanguage(); if ("MIXED".equals(type)) { type = "ALL"; } String cs = getPublisherDescriptor().getCheckers(type); checkers = getPublisherDescriptor().split2List(cs); } } catch (Exception e) { checkers = new LinkedList<String>(); } } public StreamDataObj getStream(String streamId, CIMInstance cimInstance) throws IOException, CovRemoteServiceException_Exception { StreamFilterSpecDataObj filter = new StreamFilterSpecDataObj(); filter.setNamePattern(streamId); List<StreamDataObj> streams = cimInstance.getConfigurationService().getStreams(filter); if (streams.isEmpty()) { return null; } else { return streams.get(0); } } }