bug6173: using Github release repository implementation; added tests

+ assertNotNull(SailingReleaseRepository.INSTANCE.getLatestDefaultRelease());

+import com.sap.sailing.landscape.SailingReleaseRepository;

+ return SailingReleaseRepository.INSTANCE.getRelease(version).getReleaseNotesURL().toString();

+ ReleaseRepository INSTANCE = new GithubReleasesRepository(

+ "SAP", // owner

+ "sailing-analytics", // repo name

+ "main"); // main release name prefix

+ ? SailingReleaseRepository.INSTANCE.getLatestDefaultRelease()

+ release = SailingReleaseRepository.INSTANCE.getRelease((String) status.get(STATUS_RELEASE_PROPERTY_NAME));

+ * <li>If no {@link #setRelease(Release) release} is specified, it defaults to {@link SailingReleaseRepository#getLatestDefaultRelease()}.</li>

+ return Optional.of(super.getRelease().orElse(SailingReleaseRepository.INSTANCE.getLatestDefaultRelease()));

+ "INSTALL_FROM_RELEASE="+SailingReleaseRepository.INSTANCE.getLatestDefaultRelease().getName(),

+package com.sap.sse.landscape.impl;

+

+import static org.junit.jupiter.api.Assertions.assertEquals;

+import static org.junit.jupiter.api.Assertions.assertFalse;

+import static org.junit.jupiter.api.Assertions.assertNotNull;

+

+import org.junit.jupiter.api.BeforeAll;

+import org.junit.jupiter.api.Test;

+

+import com.sap.sse.common.Util;

+import com.sap.sse.landscape.Release;

+

+public class TestFolderBasedReleaseRepository {

+ private static final String MAIN = "main";

+ private static FolderBasedReleaseRepositoryImpl repository;

+

+ @BeforeAll

+ public static void setUp() {

+ repository = new FolderBasedReleaseRepositoryImpl("https://releases.sapsailing.com", MAIN);

+ }

+

+ @Test

+ public void testAtLeastOneRelease() {

+ assertFalse(Util.isEmpty(repository));

+ }

+

+ @Test

+ public void testAtLeastOneMainRelease() {

+ final Release latestMasterRelease = repository.getLatestDefaultRelease();

+ assertNotNull(latestMasterRelease);

+ assertEquals(MAIN, latestMasterRelease.getBaseName());

+ }

+}

+package com.sap.sse.landscape.impl;

+

+import static org.junit.jupiter.api.Assertions.assertEquals;

+import static org.junit.jupiter.api.Assertions.assertFalse;

+import static org.junit.jupiter.api.Assertions.assertNotNull;

+import static org.junit.jupiter.api.Assertions.assertNull;

+

+import org.junit.jupiter.api.BeforeAll;

+import org.junit.jupiter.api.Test;

+

+import com.sap.sse.common.Util;

+import com.sap.sse.landscape.Release;

+

+public class TestGithubReleaseRepository {

+ private static final String DOCKER_25 = "docker-25";

+ private static final String MAIN = "main";

+ private static GithubReleasesRepository repository;

+

+ @BeforeAll

+ public static void setUp() {

+ repository = new GithubReleasesRepository("SAP", "sailing-analytics", MAIN);

+ }

+

+ @Test

+ public void testAtLeastOneRelease() {

+ assertFalse(Util.isEmpty(repository));

+ }

+

+ @Test

+ public void testAtLeastOneMainRelease() {

+ final Release latestMasterRelease = repository.getLatestDefaultRelease();

+ assertNotNull(latestMasterRelease);

+ assertEquals(MAIN, latestMasterRelease.getBaseName());

+ }

+

+ @Test

+ public void testAtLeastOneDocker25Release() {

+ final Release latestDocker25Release = repository.getLatestRelease(DOCKER_25);

+ assertNotNull(latestDocker25Release);

+ assertEquals(DOCKER_25, latestDocker25Release.getBaseName());

+ }

+

+ @Test

+ public void testLinkToNextPageFromFirst() {

+ assertEquals("https://api.github.com/repositories/790295432/releases?page=2",

+ repository.getNextPageURL("<https://api.github.com/repositories/790295432/releases?page=2>; rel=\"next\", <https://api.github.com/repositories/790295432/releases?page=27>; rel=\"last\""));

+ }

+

+ @Test

+ public void testLinkToNextPageFromMiddleWith100PerPage() {

+ assertEquals("https://api.github.com/repositories/790295432/releases?per_page=100&page=5",

+ repository.getNextPageURL("<https://api.github.com/repositories/790295432/releases?per_page=100&page=3>; rel=\"prev\", <https://api.github.com/repositories/790295432/releases?per_page=100&page=5>; rel=\"next\", <https://api.github.com/repositories/790295432/releases?per_page=100&page=8>; rel=\"last\", <https://api.github.com/repositories/790295432/releases?per_page=100&page=1>; rel=\"first\""));

+ }

+

+ @Test

+ public void testLinkToNextPageFromLaste() {

+ assertNull(

+ repository.getNextPageURL("<https://api.github.com/repositories/790295432/releases?per_page=100&page=7>; rel=\"prev\", <https://api.github.com/repositories/790295432/releases?per_page=100&page=1>; rel=\"first\""));

+ }

+}

+import java.text.ParseException;

+import java.text.SimpleDateFormat;

+import java.util.TimeZone;

+import java.util.logging.Level;

+import java.util.logging.Logger;

+ Logger logger = Logger.getLogger(Release.class.getName());

+

+ default String getBaseName() {

+ return getName().substring(0, getName().lastIndexOf("-"));

+

+ default TimePoint getCreationDate() {

+ final String dateSubstring = getName().substring(getName().lastIndexOf("-")+1);

+ try {

+ final SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyyMMddHHmm");

+ simpleDateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));

+ return TimePoint.of(simpleDateFormat.parse(dateSubstring));

+ } catch (ParseException e) {

+ logger.log(Level.WARNING, "Error parsing release date "+dateSubstring+". Returning null instead.", e);

+ return null;

+ }

+

+ URL getReleaseNotesURL();

+ URL getDeployableArchiveURL();

+ default Release getLatestDefaultRelease() {

+ return getLatestRelease(getDefaultReleaseNamePrefix());

+ String getDefaultReleaseNamePrefix();

+ result = releaseRepository.getRelease(matcher.group(1));

+package com.sap.sse.landscape.impl;

+

+import com.sap.sse.common.impl.NamedImpl;

+import com.sap.sse.landscape.Release;

+

+public abstract class AbstractRelease extends NamedImpl implements Release {

+ private static final long serialVersionUID = 4872094283926485605L;

+

+ public AbstractRelease(String name) {

+ super(name);

+ }

+}

+ private final String defaultReleaseNamePrefix;

+ public AbstractReleaseRepository(String defaultReleaseNamePrefix) {

+ this.defaultReleaseNamePrefix = defaultReleaseNamePrefix;

+ public String getDefaultReleaseNamePrefix() {

+ return defaultReleaseNamePrefix;

+package com.sap.sse.landscape.impl;

+

+import java.net.MalformedURLException;

+import java.net.URL;

+

+import com.sap.sse.landscape.Release;

+

+/**

+ * Collaborates with {@link FolderBasedReleaseRepositoryImpl}.

+ *

+ * @author Axel Uhl (d043530)

+ *

+ */

+public class FolderBasedReleaseImpl extends AbstractRelease implements Release {

+ private static final long serialVersionUID = -225240683033821028L;

+ private final String repositoryBase;

+

+ public FolderBasedReleaseImpl(String name, String repositoryBase) {

+ super(name);

+ this.repositoryBase = repositoryBase;

+ }

+

+ @Override

+ public URL getReleaseNotesURL() {

+ try {

+ return new URL(getDownloadFolderURL()+RELEASE_NOTES_FILE_NAME);

+ } catch (MalformedURLException e) {

+ throw new RuntimeException(e);

+ }

+ }

+

+ @Override

+ public URL getDeployableArchiveURL() {

+ try {

+ return new URL(getDownloadFolderURL()+getName()+ARCHIVE_EXTENSION);

+ } catch (MalformedURLException e) {

+ throw new RuntimeException(e);

+ }

+ }

+

+ private String getDownloadFolderURL() {

+ return repositoryBase+"/"+getName()+"/";

+ }

+}

+package com.sap.sse.landscape.impl;

+

+import java.io.ByteArrayOutputStream;

+import java.io.IOException;

+import java.io.InputStream;

+import java.net.URL;

+import java.net.URLConnection;

+import java.util.Collections;

+import java.util.LinkedList;

+import java.util.List;

+import java.util.logging.Level;

+import java.util.logging.Logger;

+import java.util.regex.Matcher;

+import java.util.regex.Pattern;

+

+import com.sap.sse.landscape.Release;

+import com.sap.sse.util.HttpUrlConnectionHelper;

+

+/**

+ * Assumes a simple folder exposed by a web server, such as Apache httpd, where the "repository base" references the

+ * folder which shows an "index" of the sub-folders in it, so that we can explore it. Each sub-folder is expected to be

+ * named after the corresponding release and must contain the release-notes.txt file (see

+ * {@link Release#RELEASE_NOTES_FILE_NAME}) as well as the .tar.gz file (see {@link Release#ARCHIVE_EXTENSION}) that

+ * represents the actual release file.

+ *

+ * @author Axel Uhl (d043530)

+ *

+ */

+public class FolderBasedReleaseRepositoryImpl extends AbstractReleaseRepository {

+ private static final Logger logger = Logger.getLogger(FolderBasedReleaseRepositoryImpl.class.getName());

+ private final String repositoryBase;

+

+ public FolderBasedReleaseRepositoryImpl(String repositoryBase, String defaultReleaseNamePrefix) {

+ super(defaultReleaseNamePrefix);

+ this.repositoryBase = repositoryBase;

+ }

+

+ private String getRepositoryBase() {

+ return repositoryBase;

+ }

+

+ protected Iterable<Release> getAvailableReleases() {

+ final List<Release> result = new LinkedList<>();

+ try {

+ final URLConnection connection = HttpUrlConnectionHelper.redirectConnection(new URL(getRepositoryBase()));

+ final InputStream index = (InputStream) connection.getContent();

+ int read = 0;

+ final ByteArrayOutputStream bos = new ByteArrayOutputStream();

+ while ((read=index.read()) != -1) {

+ bos.write(read);

+ }

+ index.close();

+ final String contents = bos.toString();

+ final Pattern pattern = Pattern.compile("<a href=\"(([^/]*)-([0-9]*))/\">([^/]*)-([0-9]*)/</a>");

+ final Matcher m = pattern.matcher(contents);

+ int lastMatch = 0;

+ while (m.find(lastMatch)) {

+ result.add(new FolderBasedReleaseImpl(m.group(1), getRepositoryBase()));

+ lastMatch = m.end();

+ }

+ } catch (IOException e) {

+ logger.log(Level.SEVERE, "Error loading releases from repository at "+getRepositoryBase()+". Continuing empty.", e);

+ return Collections.emptyList();

+ }

+ return result;

+ }

+}

+package com.sap.sse.landscape.impl;

+

+import java.net.MalformedURLException;

+import java.net.URL;

+

+import com.sap.sse.landscape.Release;

+

+public class GithubRelease extends AbstractRelease implements Release {

+ private static final long serialVersionUID = -8587383557709591724L;

+ private final String downloadURL;

+ private final String releaseNotesURL;

+

+ public GithubRelease(String name, String downloadURL, String releaseNotesURL) {

+ super(name);

+ this.downloadURL = downloadURL;

+ this.releaseNotesURL = releaseNotesURL;

+ }

+

+ @Override

+ public URL getReleaseNotesURL() {

+ try {

+ return new URL(releaseNotesURL);

+ } catch (MalformedURLException e) {

+ throw new RuntimeException(e);

+ }

+ }

+

+ @Override

+ public URL getDeployableArchiveURL() {

+ try {

+ return new URL(downloadURL);

+ } catch (MalformedURLException e) {

+ throw new RuntimeException(e);

+ }

+ }

+

+}

+import java.util.LinkedList;

+import java.util.List;

+import java.util.regex.Matcher;

+import java.util.regex.Pattern;

+import org.json.simple.JSONObject;

+/**

+ * Assumes a public GitHub repository where releases can be freely downloaded from

+ * <code>https://github.com/{owner}/{repo}/releases/download/{release-name}</code>.

+ *

+ * @author Axel Uhl (d043530)

+ */

+ private final static String GITHUB_API_BASE_URL = "https://api.github.com";

+ private final static String GITHUB_BASE_URL = "https://github.com";

+ private final String owner;

+ private final String repositoryName;

+ public GithubReleasesRepository(String owner, String repositoryName, String defaultReleaseNamePrefix) {

+ super(defaultReleaseNamePrefix);

+ this.owner = owner;

+ this.repositoryName = repositoryName;

+ }

+

+ private String getRepositoryPath() {

+ return owner+"/"+repositoryName;

+ }

+

+ private String getReleasesURL() {

+ return GITHUB_API_BASE_URL+"/repos/"+getRepositoryPath()+"/releases?per_page=100"; // TODO for unauthenticated requests there is a harsh rate limit of 60 requests per hour...

+ }

+

+ @Override

+ public Release getRelease(String releaseName) {

+ return new GithubRelease(releaseName, GITHUB_BASE_URL+"/"+getRepositoryPath()+"/releases/download/"+releaseName+"/"+releaseName+Release.ARCHIVE_EXTENSION,

+ GITHUB_BASE_URL+"/"+getRepositoryPath()+"/releases/download/"+releaseName+"/"+Release.RELEASE_NOTES_FILE_NAME);

+ final List<Release> result = new LinkedList<>();

+ String nextPageURL = getReleasesURL();

+ do {

+ final URLConnection connection = HttpUrlConnectionHelper.redirectConnection(new URL(nextPageURL));

+ final InputStream index = (InputStream) connection.getContent();

+ final String linkHeader = connection.getHeaderField("link");

+ final JSONArray releasesJson = (JSONArray) new JSONParser().parse(new InputStreamReader(index));

+ addAllReleasesTo(releasesJson, result);

+ nextPageURL = getNextPageURL(linkHeader);

+ } while (nextPageURL != null);

+ return result;

+ }

+

+ private void addAllReleasesTo(JSONArray releasesJson, List<Release> result) {

+ for (final Object releaseObject : releasesJson) {

+ final JSONObject releaseJson = (JSONObject) releaseObject;

+ final String name = releaseJson.get("name").toString();

+ String archiveDownloadURL = null;

+ String releaseNotesURL = null;

+ for (final Object archiveAsset : (JSONArray) releaseJson.get("assets")) {

+ final JSONObject archiveAssetJson = (JSONObject) archiveAsset;

+ if (archiveAssetJson.get("content_type").equals("application/x-tar")) {

+ archiveDownloadURL = archiveAssetJson.get("browser_download_url").toString();

+ } else if (archiveAssetJson.get("name").equals(Release.RELEASE_NOTES_FILE_NAME)) {

+ releaseNotesURL = archiveAssetJson.get("browser_download_url").toString();

+ }

+ }

+ result.add(new GithubRelease(name, archiveDownloadURL, releaseNotesURL));

+ }

+ private static final Pattern nextPagePattern = Pattern.compile(".*<([^<]*)>; rel=\"next\".*");

+ String getNextPageURL(String linkHeader) {

+ final String result;

+ final Matcher m = nextPagePattern.matcher(linkHeader);

+ if (m.matches()) {

+ result = m.group(1);

+ } else {

+ result = null;

+ }

+ return result;

+ }