| package org.eclipse.juno.tests.repos; |
| |
| import java.io.File; |
| import java.io.FileWriter; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.net.URISyntaxException; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Properties; |
| |
| import org.eclipse.core.runtime.OperationCanceledException; |
| import org.eclipse.equinox.internal.p2.metadata.License; |
| import org.eclipse.equinox.p2.core.ProvisionException; |
| import org.eclipse.equinox.p2.metadata.ICopyright; |
| import org.eclipse.equinox.p2.metadata.IInstallableUnit; |
| import org.eclipse.equinox.p2.metadata.ILicense; |
| import org.eclipse.equinox.p2.query.IQueryResult; |
| import org.eclipse.juno.tests.repos.TestRepo; |
| import org.eclipse.juno.tests.utils.IUIdComparator; |
| |
| public class FeatureDisplayableDataChecker extends TestRepo { |
| private static String STANDARD_LICENSES_PROPERTIES_FILE = "standardLicenses.properties"; |
| |
| private boolean checkLicenseConsistency(IQueryResult<IInstallableUnit> allFeatures) throws IOException { |
| boolean result = false; |
| Properties properties = new Properties(); |
| |
| InputStream inStream = this.getClass().getResourceAsStream(STANDARD_LICENSES_PROPERTIES_FILE); |
| properties.load(inStream); |
| String body2011 = properties.getProperty("license2011"); |
| String body2010 = properties.getProperty("license2010"); |
| ILicense standardLicense2011 = new License(null, body2011, null); |
| ILicense standardLicense2010 = new License(null, body2010, null); |
| |
| List<IInstallableUnit> noLicense = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> extraLicense = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> goodLicense = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> oldLicense = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> badLicense = new ArrayList<IInstallableUnit>(); |
| checkLicenses(standardLicense2011, standardLicense2010, allFeatures, goodLicense, oldLicense, badLicense, noLicense, extraLicense); |
| |
| printReportLicense(goodLicense, oldLicense, badLicense, noLicense, extraLicense); |
| result = ((badLicense.size() > 0) || (extraLicense.size() > 0) || (noLicense.size() > 0)); |
| return result; |
| } |
| |
| private void checkLicenses(ILicense platformLicense2011, ILicense platformLicense2010, IQueryResult<IInstallableUnit> allFeatures, List<IInstallableUnit> goodLicense, List<IInstallableUnit> oldLicense, List<IInstallableUnit> badLicense, List<IInstallableUnit> noLicense, List<IInstallableUnit> extraLicense) { |
| System.out.println("Number of IUs during license check: " + allFeatures.toUnmodifiableSet().size()); |
| int nFeatures = 0; |
| int nNonFeatures = 0; |
| for (IInstallableUnit feature : allFeatures.toUnmodifiableSet()) { |
| // System.out.println("Feature ID: " + feature.getId()); |
| // ignore IUs that are not features |
| // TODO: but, we get "groups" ... what kind of groups are not feature groups? |
| if (feature.getId().endsWith(".feature.group")) { |
| nFeatures++; |
| Collection<ILicense> licenses = feature.getLicenses(null); |
| if (licenses.isEmpty()) { |
| noLicense.add(feature); |
| continue; |
| } |
| if (licenses.size() != 1) { |
| extraLicense.add(feature); |
| continue; |
| } |
| ILicense featureLicense = licenses.iterator().next(); |
| if (platformLicense2010.getUUID().equals(featureLicense.getUUID())) { |
| oldLicense.add(feature); |
| continue; |
| } |
| if (platformLicense2011.getUUID().equals(featureLicense.getUUID())) { |
| goodLicense.add(feature); |
| continue; |
| } |
| badLicense.add(feature); |
| } |
| else { |
| nNonFeatures++; |
| } |
| } |
| System.out.println("Number features during license check: " + nFeatures); |
| System.out.println("Number non-featues during license check: " + nNonFeatures); |
| } |
| |
| private void printReportLicense(List<IInstallableUnit> goodLicense, List<IInstallableUnit> oldLicense, List<IInstallableUnit> badLicense, List<IInstallableUnit> noLicense, List<IInstallableUnit> extraLicense) { |
| String SPACER = "<br />======================="; |
| |
| FileWriter outfileWriter = null; |
| File outfile = null; |
| String testDirName = getOutputDirectory(); |
| try { |
| outfile = new File(testDirName, "licenseConsistency.html"); |
| outfileWriter = new FileWriter(outfile); |
| System.out.println("output: " + outfile.getAbsolutePath()); |
| println(outfileWriter, "<p>Repository ('repoURLToTest'): " + getRepoURLToTest() + "</p>" + EOL); |
| println(outfileWriter, "<br /><br />License Consistency Summary:" + SPACER); |
| println(outfileWriter, "Features with conforming (2011) license: " + goodLicense.size()); |
| println(outfileWriter, "Features with old (2010) license: " + oldLicense.size()); |
| println(outfileWriter, "Features with different license: " + badLicense.size()); |
| println(outfileWriter, "Features with no license: " + noLicense.size()); |
| println(outfileWriter, "Features with extra licenses: " + extraLicense.size()); |
| println(outfileWriter, "======================="); |
| |
| println(outfileWriter, "<br /><br />Details:" + SPACER); |
| |
| println(outfileWriter, "Features with no license:" + SPACER); |
| Collections.sort(noLicense, new IUIdComparator()); |
| for (IInstallableUnit unit : noLicense) { |
| println(outfileWriter, unit.getId()); |
| } |
| |
| println(outfileWriter, "<br /><br />Features with different license:" + SPACER); |
| Collections.sort(badLicense, new IUIdComparator()); |
| for (IInstallableUnit unit : badLicense) { |
| println(outfileWriter, unit.getId()); |
| } |
| println(outfileWriter, "<br /><br />Features with old (2010) license:" + SPACER); |
| Collections.sort(oldLicense, new IUIdComparator()); |
| for (IInstallableUnit unit : oldLicense) { |
| println(outfileWriter, unit.getId()); |
| } |
| println(outfileWriter, "<br /><br />Features with matching (2011) license:" + SPACER); |
| Collections.sort(goodLicense, new IUIdComparator()); |
| for (IInstallableUnit unit : goodLicense) { |
| println(outfileWriter, unit.getId()); |
| } |
| } |
| catch (IOException e) { |
| e.printStackTrace(); |
| } |
| finally { |
| if (outfileWriter != null) { |
| try { |
| outfileWriter.close(); |
| } |
| catch (IOException e) { |
| // weirdness |
| e.printStackTrace(); |
| } |
| } |
| } |
| // if ((badLicense.size() > 0) || (extraLicense.size() > 0) || (noLicense.size() > 0)) { |
| // fail("Errors in license consistency. For list, see " + outfile.getAbsolutePath()); |
| // } |
| } |
| |
| public boolean testDisplayableData() throws URISyntaxException, ProvisionException, OperationCanceledException, IOException { |
| boolean result = false; |
| IQueryResult<IInstallableUnit> allIUs = getAllGroupIUs(); |
| result = checkLicenseConsistency(allIUs); |
| result = result | checkCopyrights(allIUs); |
| result = result | checkDescriptions(allIUs); |
| return result; |
| } |
| |
| private boolean checkCopyrights(IQueryResult<IInstallableUnit> allFeatures) { |
| boolean result = false; |
| |
| List<IInstallableUnit> noOrBadCopyright = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> okCopyright = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> indeterminateCopyright = new ArrayList<IInstallableUnit>(); |
| |
| for (IInstallableUnit feature : allFeatures.toUnmodifiableSet()) { |
| if (feature.getId().endsWith(".feature.group")) { |
| ICopyright copyright = feature.getCopyright(null); |
| if (copyright == null) { |
| noOrBadCopyright.add(feature); |
| continue; |
| } |
| String body = copyright.getBody(); |
| if ((body == null) || (body.length() == 0) || body.startsWith("%") || body.startsWith("[")) { |
| noOrBadCopyright.add(feature); |
| continue; |
| } |
| |
| if (body.startsWith("Copyright") || body.startsWith("(c) Copyright")) { |
| okCopyright.add(feature); |
| continue; |
| } |
| // the order of these tests clauses matter, obvously. (Compare with above 'startsWith'.) |
| if (body.contains("Copyright") || body.contains("copyright")) { |
| indeterminateCopyright.add(feature); |
| continue; |
| } |
| // fallthrough assumed "bad" |
| noOrBadCopyright.add(feature); |
| } |
| |
| } |
| |
| printReportCopyrights(okCopyright, noOrBadCopyright, indeterminateCopyright); |
| result = ((noOrBadCopyright.size() > 0)); |
| return result; |
| } |
| |
| private boolean checkDescriptions(IQueryResult<IInstallableUnit> allFeatures) { |
| boolean result = false; |
| |
| List<IInstallableUnit> noneOrBad = new ArrayList<IInstallableUnit>(); |
| List<IInstallableUnit> ok = new ArrayList<IInstallableUnit>(); |
| |
| for (IInstallableUnit feature : allFeatures.toUnmodifiableSet()) { |
| if (feature.getId().endsWith(".feature.group")) { |
| String description = feature.getProperty(IInstallableUnit.PROP_DESCRIPTION, null); |
| if ((description == null) || (description.length() <= 0) || description.startsWith("%")) { |
| noneOrBad.add(feature); |
| continue; |
| } |
| |
| ok.add(feature); |
| } |
| |
| } |
| |
| printReportDescription(ok, noneOrBad); |
| result = ((noneOrBad.size() > 0)); |
| return result; |
| } |
| |
| private void printReportDescription(List<IInstallableUnit> ok, List<IInstallableUnit> noneOrBad) { |
| String SPACER = "<br />======================="; |
| |
| FileWriter outfileWriter = null; |
| File outfile = null; |
| String testDirName = getOutputDirectory(); |
| try { |
| outfile = new File(testDirName, "descriptions.html"); |
| outfileWriter = new FileWriter(outfile); |
| System.out.println("output: " + outfile.getAbsolutePath()); |
| println(outfileWriter, "<p>Repository ('repoURLToTest'): " + getRepoURLToTest() + "</p>" + EOL); |
| println(outfileWriter, "<br /><br />Description Report:" + SPACER); |
| println(outfileWriter, "Features wrong or unexplainable descriptions: " + noneOrBad.size()); |
| println(outfileWriter, "Features probably correct: " + ok.size()); |
| println(outfileWriter, "======================="); |
| |
| println(outfileWriter, "<br /><br />Details:" + SPACER); |
| |
| println(outfileWriter, "Features with no or dubious descripiton:" + SPACER); |
| Collections.sort(noneOrBad, new IUIdComparator()); |
| for (IInstallableUnit unit : noneOrBad) { |
| printLineDescription(outfileWriter, unit); |
| } |
| |
| println(outfileWriter, "<br /><br />Features with descripitons:" + SPACER); |
| Collections.sort(ok, new IUIdComparator()); |
| for (IInstallableUnit unit : ok) { |
| printLineDescription(outfileWriter, unit); |
| } |
| |
| } |
| catch (IOException e) { |
| e.printStackTrace(); |
| } |
| finally { |
| if (outfileWriter != null) { |
| try { |
| outfileWriter.close(); |
| } |
| catch (IOException e) { |
| // weirdness |
| e.printStackTrace(); |
| } |
| } |
| } |
| // if ((badLicense.size() > 0) || (extraLicense.size() > 0) || (noLicense.size() > 0)) { |
| // fail("Errors in license consistency. For list, see " + outfile.getAbsolutePath()); |
| // } |
| } |
| |
| |
| |
| private void printReportCopyrights(List<IInstallableUnit> good, List<IInstallableUnit> bad, List<IInstallableUnit> maybe) { |
| String SPACER = "<br />======================="; |
| |
| FileWriter outfileWriter = null; |
| File outfile = null; |
| String testDirName = getOutputDirectory(); |
| try { |
| outfile = new File(testDirName, "copyrights.html"); |
| outfileWriter = new FileWriter(outfile); |
| System.out.println("output: " + outfile.getAbsolutePath()); |
| println(outfileWriter, "<p>Repository ('repoURLToTest'): " + getRepoURLToTest() + "</p>" + EOL); |
| println(outfileWriter, "<br /><br />Copyright Report:" + SPACER); |
| println(outfileWriter, "Features wrong or unexplainable copyrights: " + bad.size()); |
| println(outfileWriter, "Features maybe wrong, maybe correct copyrights: " + maybe.size()); |
| println(outfileWriter, "Features probably correct: " + good.size()); |
| println(outfileWriter, "======================="); |
| |
| println(outfileWriter, "<br /><br />Details:" + SPACER); |
| |
| println(outfileWriter, "Features with no or probably incorrect copyright statement:" + SPACER); |
| Collections.sort(bad, new IUIdComparator()); |
| for (IInstallableUnit unit : bad) { |
| printLineCopyright(outfileWriter, unit); |
| } |
| |
| println(outfileWriter, "<br /><br />Indeterminant: feature's copyright text contains the word 'copyright' but not at beginning:" + SPACER); |
| Collections.sort(maybe, new IUIdComparator()); |
| for (IInstallableUnit unit : maybe) { |
| printLineCopyright(outfileWriter, unit); |
| } |
| println(outfileWriter, "<br /><br />Features with copyrights that are probably ok (i.e. start with 'Copyright'):" + SPACER); |
| Collections.sort(good, new IUIdComparator()); |
| for (IInstallableUnit unit : good) { |
| printLineCopyright(outfileWriter, unit); |
| } |
| |
| } |
| catch (IOException e) { |
| e.printStackTrace(); |
| } |
| finally { |
| if (outfileWriter != null) { |
| try { |
| outfileWriter.close(); |
| } |
| catch (IOException e) { |
| // weirdness |
| e.printStackTrace(); |
| } |
| } |
| } |
| // if ((badLicense.size() > 0) || (extraLicense.size() > 0) || (noLicense.size() > 0)) { |
| // fail("Errors in license consistency. For list, see " + outfile.getAbsolutePath()); |
| // } |
| } |
| |
| private void printLineCopyright(FileWriter outfileWriter, IInstallableUnit iu) throws IOException { |
| |
| String copyright = null; |
| ICopyright copyrightIu = iu.getCopyright(null); |
| if (copyrightIu != null) { |
| copyright = copyrightIu.getBody(); |
| } |
| String iuId = iu.getId(); |
| String iuVersion = iu.getVersion().toString(); |
| println(outfileWriter, iuId + NBSP + iuVersion + BR + NBSP + copyright); |
| } |
| |
| private void printLineDescription(FileWriter outfileWriter, IInstallableUnit iu) throws IOException { |
| |
| |
| String description = iu.getProperty(IInstallableUnit.PROP_DESCRIPTION, null); |
| String iuId = iu.getId(); |
| String iuVersion = iu.getVersion().toString(); |
| println(outfileWriter, iuId + NBSP + iuVersion + BR + NBSP + description); |
| } |
| } |
