Add support for OCI package type #386 (#387)

jfrog · Sep 2, 2024 · fce2baa · fce2baa
1 parent dc993c3
commit fce2baa
Show file tree

Hide file tree

Showing 9 changed files with 166 additions and 6 deletions.
diff --git a/...in/java/org/jfrog/artifactory/client/model/repository/settings/OciRepositorySettings.java b/...in/java/org/jfrog/artifactory/client/model/repository/settings/OciRepositorySettings.java
@@ -0,0 +1,8 @@
+package org.jfrog.artifactory.client.model.repository.settings;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public interface OciRepositorySettings extends DockerRepositorySettings {
+
+}
diff --git a/...ices/src/main/java/org/jfrog/artifactory/client/impl/jackson/RepositorySettingsMixIn.java b/...ices/src/main/java/org/jfrog/artifactory/client/impl/jackson/RepositorySettingsMixIn.java
@@ -43,7 +43,8 @@
     @JsonSubTypes.Type(value = HelmRepositorySettingsImpl.class, name = "helm"),
     @JsonSubTypes.Type(value = GoRepositorySettingsImpl.class, name = "go"),
     @JsonSubTypes.Type(value = CargoRepositorySettingsImpl.class, name = "cargo"),
-    @JsonSubTypes.Type(value = TerraformRepositorySettingsImpl.class, name = "terraform")
+    @JsonSubTypes.Type(value = TerraformRepositorySettingsImpl.class, name = "terraform"),
+    @JsonSubTypes.Type(value = OciRepositorySettingsImpl.class, name = "oci")
 })
 
 public abstract class RepositorySettingsMixIn {

diff --git a/...src/main/java/org/jfrog/artifactory/client/model/impl/FederatedRepositoryBuilderImpl.java b/...src/main/java/org/jfrog/artifactory/client/model/impl/FederatedRepositoryBuilderImpl.java
@@ -16,7 +16,7 @@
  */
 public class FederatedRepositoryBuilderImpl extends NonVirtualRepositoryBuilderBase<FederatedRepositoryBuilder, FederatedRepository> implements FederatedRepositoryBuilder {
     private static Set<PackageType> federatedRepositorySupportedTypes = new HashSet<>(Arrays.asList(
-            bower, cocoapods, cran, conda, debian, docker, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, opkg, pypi, sbt, vagrant, yum, rpm, composer, conan, chef, puppet, helm, go, cargo, terraform
+            bower, cocoapods, cran, conda, debian, docker, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, opkg, pypi, sbt, vagrant, yum, rpm, composer, conan, chef, puppet, helm, go, cargo, terraform, oci
     ));
 
     protected List<FederatedMember> members = new ArrayList<>();

diff --git a/...ces/src/main/java/org/jfrog/artifactory/client/model/impl/LocalRepositoryBuilderImpl.java b/...ces/src/main/java/org/jfrog/artifactory/client/model/impl/LocalRepositoryBuilderImpl.java
@@ -17,7 +17,7 @@
  */
 public class LocalRepositoryBuilderImpl extends NonVirtualRepositoryBuilderBase<LocalRepositoryBuilder, LocalRepository> implements LocalRepositoryBuilder {
     private static Set<PackageType> localRepositorySupportedTypes = new HashSet<PackageType>(Arrays.asList(
-            bower, cocoapods, cran, conda, debian, docker, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, opkg, pypi, sbt, vagrant, yum, rpm, composer, conan, chef, puppet, helm, go, cargo, terraform
+            bower, cocoapods, cran, conda, debian, docker, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, opkg, pypi, sbt, vagrant, yum, rpm, composer, conan, chef, puppet, helm, go, cargo, terraform, oci
     ));
 
     protected LocalRepositoryBuilderImpl() {

diff --git a/services/src/main/java/org/jfrog/artifactory/client/model/impl/PackageTypeImpl.java b/services/src/main/java/org/jfrog/artifactory/client/model/impl/PackageTypeImpl.java
@@ -33,7 +33,8 @@ public enum PackageTypeImpl implements PackageType {
     helm,
     go,
     cargo,
-    terraform;
+    terraform,
+    oci;
 
     @Override
     public boolean isCustom() {

diff --git a/...es/src/main/java/org/jfrog/artifactory/client/model/impl/RemoteRepositoryBuilderImpl.java b/...es/src/main/java/org/jfrog/artifactory/client/model/impl/RemoteRepositoryBuilderImpl.java
@@ -17,7 +17,7 @@
  */
 public class RemoteRepositoryBuilderImpl extends NonVirtualRepositoryBuilderBase<RemoteRepositoryBuilder, RemoteRepository> implements RemoteRepositoryBuilder {
     private static Set<PackageType> remoteRepositorySupportedTypes = new HashSet<PackageType>(Arrays.asList(
-            bower, cocoapods, cran, conda, debian, docker, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, opkg, p2, pypi, sbt, vcs, yum, rpm, composer, conan, chef, puppet, helm, go, cargo, terraform
+            bower, cocoapods, cran, conda, debian, docker, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, opkg, p2, pypi, sbt, vcs, yum, rpm, composer, conan, chef, puppet, helm, go, cargo, terraform, oci
     ));
 
     private String url;

diff --git a/...s/src/main/java/org/jfrog/artifactory/client/model/impl/VirtualRepositoryBuilderImpl.java b/...s/src/main/java/org/jfrog/artifactory/client/model/impl/VirtualRepositoryBuilderImpl.java
@@ -15,7 +15,7 @@
  */
 public class VirtualRepositoryBuilderImpl extends RepositoryBuilderBase<VirtualRepositoryBuilder, VirtualRepository> implements VirtualRepositoryBuilder {
     private static Set<PackageType> virtualRepositorySupportedTypes = new HashSet<PackageType>(Arrays.asList(
-            bower, cran, conda, docker, debian, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, p2, pypi, sbt, yum, rpm, composer, conan, chef, puppet, helm, go, terraform
+            bower, cran, conda, docker, debian, gems, generic, gitlfs, gradle, ivy, maven, npm, nuget, p2, pypi, sbt, yum, rpm, composer, conan, chef, puppet, helm, go, terraform, oci
     ));
 
     private Collection<String> repositories = Collections.emptyList();

diff --git a/...rg/jfrog/artifactory/client/model/repository/settings/impl/OciRepositorySettingsImpl.java b/...rg/jfrog/artifactory/client/model/repository/settings/impl/OciRepositorySettingsImpl.java
@@ -0,0 +1,21 @@
+package org.jfrog.artifactory.client.model.repository.settings.impl;
+
+import org.jfrog.artifactory.client.model.PackageType;
+import org.jfrog.artifactory.client.model.impl.PackageTypeImpl;
+import org.jfrog.artifactory.client.model.repository.settings.OciRepositorySettings;
+
+public class OciRepositorySettingsImpl extends DockerRepositorySettingsImpl implements OciRepositorySettings {
+    public static String defaultLayout = "simple-default";
+
+    public PackageType getPackageType() {
+        return PackageTypeImpl.oci;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof OciRepositorySettingsImpl)) {
+            return false;
+        }
+        return super.equals(o);
+    }
+}
diff --git a/services/src/test/groovy/org/jfrog/artifactory/client/OciPackageTypeRepositoryTests.groovy b/services/src/test/groovy/org/jfrog/artifactory/client/OciPackageTypeRepositoryTests.groovy
@@ -0,0 +1,129 @@
+package org.jfrog.artifactory.client
+
+import org.hamcrest.CoreMatchers
+import org.jfrog.artifactory.client.model.RepositoryType
+import org.jfrog.artifactory.client.model.repository.settings.RepositorySettings
+import org.jfrog.artifactory.client.model.repository.settings.docker.DockerApiVersion
+import org.jfrog.artifactory.client.model.repository.settings.impl.OciRepositorySettingsImpl
+import org.testng.annotations.BeforeMethod
+import org.testng.annotations.Test
+
+/**
+ * test that client correctly sends and receives repository configuration with `oci` package type
+ *
+ */
+class OciPackageTypeRepositoryTests extends BaseRepositoryTests {
+
+    OciPackageTypeRepositoryTests() {
+        remoteRepoUrl = "https://registry-1.docker.io"
+    }
+
+    @Override
+    RepositorySettings getRepositorySettings(RepositoryType repositoryType) {
+        def settings = new OciRepositorySettingsImpl()
+
+        settings.with {
+            // local
+            dockerApiVersion = DockerApiVersion.V2
+            dockerTagRetention = Math.abs(rnd.nextInt())
+
+            // remote
+            enableTokenAuthentication = rnd.nextBoolean()
+            listRemoteFolderItems = rnd.nextBoolean()
+        }
+
+        return settings
+    }
+
+    @BeforeMethod
+    protected void setUp() {
+        storeArtifactsLocallyInRemoteRepo = true
+        super.setUp()
+    }
+
+    @Test(groups = "ociPackageTypeRepo")
+    void testOciLocalRepo() {
+        artifactory.repositories().create(0, localRepo)
+        def expectedSettings = localRepo.repositorySettings
+
+        def resp = artifactory.repository(localRepo.getKey()).get()
+        assertThat(resp, CoreMatchers.notNullValue())
+        assertThat(resp.repoLayoutRef, CoreMatchers.is(OciRepositorySettingsImpl.defaultLayout))
+        resp.getRepositorySettings().with {
+            assertThat(packageType, CoreMatchers.is(expectedSettings.getPackageType()))
+            assertThat(repoLayout, CoreMatchers.is(expectedSettings.getRepoLayout()))
+
+            // local
+            assertThat(dockerApiVersion, CoreMatchers.is(expectedSettings.getDockerApiVersion()))
+            assertThat(dockerTagRetention, CoreMatchers.is(expectedSettings.getDockerTagRetention()))
+
+            // remote
+            assertThat(enableTokenAuthentication, CoreMatchers.is(CoreMatchers.nullValue()))
+            assertThat(listRemoteFolderItems, CoreMatchers.is(CoreMatchers.nullValue()))
+        }
+    }
+
+    @Test(groups = "ociPackageTypeRepo")
+    void testOciFederatedRepo() {
+        artifactory.repositories().create(0, federatedRepo)
+        def expectedSettings = federatedRepo.repositorySettings
+
+        def resp = artifactory.repository(federatedRepo.getKey()).get()
+        assertThat(resp, CoreMatchers.notNullValue())
+        assertThat(resp.repoLayoutRef, CoreMatchers.is(OciRepositorySettingsImpl.defaultLayout))
+        resp.getRepositorySettings().with {
+            assertThat(packageType, CoreMatchers.is(expectedSettings.getPackageType()))
+            assertThat(repoLayout, CoreMatchers.is(expectedSettings.getRepoLayout()))
+
+            // local
+            assertThat(dockerApiVersion, CoreMatchers.is(expectedSettings.getDockerApiVersion()))
+
+            // remote
+            assertThat(enableTokenAuthentication, CoreMatchers.is(CoreMatchers.nullValue()))
+            assertThat(listRemoteFolderItems, CoreMatchers.is(CoreMatchers.nullValue()))
+        }
+    }
+
+    @Test(groups = "ociPackageTypeRepo")
+    void testOciRemoteRepo() {
+        artifactory.repositories().create(0, remoteRepo)
+        def expectedSettings = remoteRepo.repositorySettings
+
+        def resp = artifactory.repository(remoteRepo.getKey()).get()
+        assertThat(resp, CoreMatchers.notNullValue())
+        assertThat(resp.repoLayoutRef, CoreMatchers.is(OciRepositorySettingsImpl.defaultLayout))
+        resp.getRepositorySettings().with {
+            assertThat(packageType, CoreMatchers.is(expectedSettings.getPackageType()))
+            assertThat(repoLayout, CoreMatchers.is(expectedSettings.getRepoLayout()))
+
+            // local
+            assertThat(dockerApiVersion, CoreMatchers.is(expectedSettings.getDockerApiVersion()))
+            // always in resp payload
+
+            // remote
+            assertThat(enableTokenAuthentication, CoreMatchers.is(expectedSettings.getEnableTokenAuthentication()))
+            assertThat(listRemoteFolderItems, CoreMatchers.is(expectedSettings.getListRemoteFolderItems()))
+        }
+    }
+
+    @Test(groups = "ociPackageTypeRepo")
+    void testDockerVirtualRepo() {
+        artifactory.repositories().create(0, virtualRepo)
+        def expectedSettings = virtualRepo.repositorySettings
+
+        def resp = artifactory.repository(virtualRepo.getKey()).get()
+        assertThat(resp, CoreMatchers.notNullValue())
+        assertThat(resp.repoLayoutRef, CoreMatchers.is(OciRepositorySettingsImpl.defaultLayout))
+        resp.getRepositorySettings().with {
+            assertThat(packageType, CoreMatchers.is(expectedSettings.getPackageType()))
+            assertThat(repoLayout, CoreMatchers.is(expectedSettings.getRepoLayout()))
+
+            // local
+            assertThat(dockerApiVersion, CoreMatchers.is(expectedSettings.getDockerApiVersion()))
+
+            // remote
+            assertThat(enableTokenAuthentication, CoreMatchers.is(CoreMatchers.nullValue()))
+            assertThat(listRemoteFolderItems, CoreMatchers.is(CoreMatchers.nullValue()))
+        }
+    }
+}