ArtifactRepository tenant aware. (#539)

* ArtifactRepository tenant aware. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * No need to have this protected. Updated event to boot > 1.3 Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Remove conditional. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Remove Debug log. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Cleanup Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Missing validation and readability. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix test after change. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix computation is DosFilter Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix session state on RESTful APIs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Performance improvement controllermanagement Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Added cross tenant test. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Typos. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>
2017-06-14 19:07:52 +02:00
parent 787042ce85
commit 8d17d21259
27 changed files with 340 additions and 160 deletions
--- a/extensions/hawkbit-extension-artifact-repository-mongo/src/main/java/org/eclipse/hawkbit/artifact/repository/MongoDBArtifactStore.java
+++ b/extensions/hawkbit-extension-artifact-repository-mongo/src/main/java/org/eclipse/hawkbit/artifact/repository/MongoDBArtifactStore.java
@@ -24,13 +24,13 @@ import java.util.stream.Collectors;

 import org.eclipse.hawkbit.artifact.repository.model.DbArtifact;
 import org.eclipse.hawkbit.artifact.repository.model.DbArtifactHash;
+import org.eclipse.hawkbit.tenancy.TenantAware;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.data.mongodb.core.MongoTemplate;
 import org.springframework.data.mongodb.core.query.Criteria;
 import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.data.mongodb.gridfs.GridFsOperations;
+import org.springframework.validation.annotation.Validated;

 import com.google.common.io.BaseEncoding;
 import com.google.common.io.ByteStreams;
@@ -44,6 +44,7 @@ import com.mongodb.gridfs.GridFSFile;
 * The file management which looks up all the file in the file tore.
 *
 */
+@Validated
 public class MongoDBArtifactStore implements ArtifactRepository {

    private static final Logger LOGGER = LoggerFactory.getLogger(MongoDBArtifactStore.class);
@@ -56,9 +57,14 @@ public class MongoDBArtifactStore implements ArtifactRepository {
    private static final String FILENAME = "filename";

    /**
-     * The mongoDB field which automatically calculated by the mongoDB.
+     * The mongoDB field which holds the tenant of the file to download.
     */
-    private static final String MD5 = "md5";
+    private static final String TENANT = "tenant";
+
+    /**
+     * Query by {@link TenantAware} field.
+     */
+    private static final String TENANT_QUERY = "metadata." + TENANT;

    /**
     * The mongoDB field which holds the SHA1 hash, stored in the meta data
@@ -68,10 +74,11 @@ public class MongoDBArtifactStore implements ArtifactRepository {

    private static final String ID = "_id";

-    @Autowired
-    private GridFsOperations gridFs;
+    private final GridFsOperations gridFs;

-    MongoTemplate mongoTemplate;
+    MongoDBArtifactStore(final GridFsOperations gridFs) {
+        this.gridFs = gridFs;
+    }

    /**
     * Retrieves a {@link GridFSDBFile} from the store by it's SHA1 hash.
@@ -82,36 +89,28 @@ public class MongoDBArtifactStore implements ArtifactRepository {
     * @return The DbArtifact object or {@code null} if no file exists.
     */
    @Override
-    public DbArtifact getArtifactBySha1(final String sha1Hash) {
-        return map(gridFs.findOne(new Query().addCriteria(Criteria.where(FILENAME).is(sha1Hash))));
-    }
+    public DbArtifact getArtifactBySha1(final String tenant, final String sha1Hash) {

-    /**
-     * Retrieves a {@link GridFSDBFile} from the store by it's MD5 hash.
-     * 
-     * @param md5Hash
-     *            the md5-hash of the file to lookup.
-     * @return The gridfs file object or {@code null} if no file exists.
-     */
-    public DbArtifact getArtifactByMd5(final String md5Hash) {
-        return map(gridFs.findOne(new Query().addCriteria(Criteria.where(MD5).is(md5Hash))));
+        return map(gridFs.findOne(new Query()
+                .addCriteria(Criteria.where(FILENAME).is(sha1Hash).and(TENANT_QUERY).is(sanitizeTenant(tenant)))));
    }

    @Override
-    public DbArtifact store(final InputStream content, final String filename, final String contentType) {
-        return store(content, filename, contentType, null);
+    public DbArtifact store(final String tenant, final InputStream content, final String filename,
+            final String contentType) {
+        return store(tenant, content, filename, contentType, null);
    }

    @Override
-    public DbArtifact store(final InputStream content, final String filename, final String contentType,
-            final DbArtifactHash hash) {
+    public DbArtifact store(final String tenant, final InputStream content, final String filename,
+            final String contentType, final DbArtifactHash hash) {
        File tempFile = null;
        try {
            LOGGER.debug("storing file {} of content {}", filename, contentType);
            tempFile = File.createTempFile("uploadFile", null);
            try (final BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(tempFile))) {
                try (BufferedInputStream bis = new BufferedInputStream(content)) {
-                    return store(bis, contentType, bos, tempFile, hash);
+                    return store(tenant, bis, contentType, bos, tempFile, hash);
                }
            }
        } catch (final IOException | MongoException e1) {
@@ -123,10 +122,15 @@ public class MongoDBArtifactStore implements ArtifactRepository {
        }
    }

+    private static String sanitizeTenant(final String tenant) {
+        return tenant.trim().toUpperCase();
+    }
+
    @Override
-    public void deleteBySha1(final String sha1Hash) {
+    public void deleteBySha1(final String tenant, final String sha1Hash) {
        try {
-            deleteArtifact(gridFs.findOne(new Query().addCriteria(Criteria.where(FILENAME).is(sha1Hash))));
+            deleteArtifact(gridFs.findOne(new Query()
+                    .addCriteria(Criteria.where(FILENAME).is(sha1Hash).and(TENANT_QUERY).is(sanitizeTenant(tenant)))));
        } catch (final MongoException e) {
            throw new ArtifactStoreException(e.getMessage(), e);
        }
@@ -143,18 +147,21 @@ public class MongoDBArtifactStore implements ArtifactRepository {

    }

-    private DbArtifact store(final InputStream content, final String contentType, final OutputStream os,
+    private DbArtifact store(final String t, final InputStream content, final String contentType, final OutputStream os,
            final File tempFile, final DbArtifactHash hash) {
        final GridFsArtifact storedArtifact;
+        final String tenant = sanitizeTenant(t);
        try {
            final String sha1Hash = computeSHA1Hash(content, os, hash != null ? hash.getSha1() : null);
            // upload if it does not exist already, check if file exists, not
            // tenant specific.
-            final GridFSDBFile result = gridFs.findOne(new Query().addCriteria(Criteria.where(FILENAME).is(sha1Hash)));
-            if (null == result) {
+            final GridFSDBFile result = gridFs.findOne(
+                    new Query().addCriteria(Criteria.where(FILENAME).is(sha1Hash).and(TENANT_QUERY).is(tenant)));
+            if (result == null) {
                try (FileInputStream inputStream = new FileInputStream(tempFile)) {
                    final BasicDBObject metadata = new BasicDBObject();
                    metadata.put(SHA1, sha1Hash);
+                    metadata.put(TENANT, tenant);
                    storedArtifact = map(gridFs.store(inputStream, sha1Hash, contentType, metadata));
                }
            } else {
@@ -244,4 +251,13 @@ public class MongoDBArtifactStore implements ArtifactRepository {
        artifact.setHashes(new DbArtifactHash(fsFile.getFilename(), fsFile.getMD5()));
        return artifact;
    }
+
+    @Override
+    public void deleteByTenant(final String tenant) {
+        try {
+            gridFs.delete(new Query().addCriteria(Criteria.where(TENANT_QUERY).is(sanitizeTenant(tenant))));
+        } catch (final MongoClientException e) {
+            throw new ArtifactStoreException(e.getMessage(), e);
+        }
+    }
 }
--- a/extensions/hawkbit-extension-artifact-repository-mongo/src/main/java/org/eclipse/hawkbit/artifact/repository/MongoDBArtifactStoreAutoConfiguration.java
+++ b/extensions/hawkbit-extension-artifact-repository-mongo/src/main/java/org/eclipse/hawkbit/artifact/repository/MongoDBArtifactStoreAutoConfiguration.java
@@ -12,6 +12,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.PropertySource;
+import org.springframework.data.mongodb.gridfs.GridFsOperations;

 /**
 * Auto configuration for the {@link MongoDBArtifactStore}.
@@ -25,7 +26,7 @@ public class MongoDBArtifactStoreAutoConfiguration {
     * @return Default {@link ArtifactRepository} implementation.
     */
    @Bean
-    public ArtifactRepository artifactRepository() {
-        return new MongoDBArtifactStore();
+    ArtifactRepository artifactRepository(final GridFsOperations gridFs) {
+        return new MongoDBArtifactStore(gridFs);
    }
 }
--- a/extensions/hawkbit-extension-artifact-repository-mongo/src/test/java/org/eclipse/hawkbit/artifact/repository/MongoDBArtifactStoreTest.java
+++ b/extensions/hawkbit-extension-artifact-repository-mongo/src/test/java/org/eclipse/hawkbit/artifact/repository/MongoDBArtifactStoreTest.java
@@ -20,54 +20,75 @@ import org.eclipse.hawkbit.artifact.TestConfiguration;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.SpringApplicationConfiguration;
-import org.springframework.data.mongodb.gridfs.GridFsOperations;
-import org.springframework.test.context.TestPropertySource;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

 import com.google.common.io.BaseEncoding;

 import ru.yandex.qatools.allure.annotations.Description;
 import ru.yandex.qatools.allure.annotations.Features;
+import ru.yandex.qatools.allure.annotations.Step;
 import ru.yandex.qatools.allure.annotations.Stories;

@Features("Component Tests - Repository")
@Stories("Artifact Store MongoDB")
@RunWith(SpringJUnit4ClassRunner.class)
-@SpringApplicationConfiguration(classes = { MongoDBArtifactStoreAutoConfiguration.class, TestConfiguration.class })
-@TestPropertySource(properties = { "spring.data.mongodb.port=0", "spring.mongodb.embedded.version=3.2.7" })
+@SpringBootTest(classes = { MongoDBArtifactStoreAutoConfiguration.class, TestConfiguration.class }, properties = {
+        "spring.data.mongodb.port=0", "spring.mongodb.embedded.version=3.4.4" })
 public class MongoDBArtifactStoreTest {
+    private static final String TENANT = "test_tenant";
+    private static final String TENANT2 = "test_tenant2";

    @Autowired
    private MongoDBArtifactStore artifactStoreUnderTest;

-    @Autowired
-    private GridFsOperations gridFs;
-
    @Test
    @Description("Ensures that search by SHA1 hash (which is used by hawkBit as artifact ID) finds the expected results.")
    public void findArtifactBySHA1Hash() throws NoSuchAlgorithmException {
+
+        final String sha1 = storeRandomArifactAndVerify(TENANT);
+        final String sha2 = storeRandomArifactAndVerify(TENANT2);
+
+        assertThat(artifactStoreUnderTest.getArtifactBySha1(TENANT2, sha1)).isNull();
+        assertThat(artifactStoreUnderTest.getArtifactBySha1(TENANT, sha2)).isNull();
+    }
+
+    @Step
+    private String storeRandomArifactAndVerify(final String tenant) throws NoSuchAlgorithmException {
        final int filelengthBytes = 128;
        final String filename = "testfile.json";
        final String contentType = "application/json";

        final DigestInputStream digestInputStream = digestInputStream(generateInputStream(filelengthBytes), "SHA-1");
-        artifactStoreUnderTest.store(digestInputStream, filename, contentType);
-        assertThat(artifactStoreUnderTest.getArtifactBySha1(
-                BaseEncoding.base16().lowerCase().encode(digestInputStream.getMessageDigest().digest()))).isNotNull();
+        artifactStoreUnderTest.store(tenant, digestInputStream, filename, contentType);
+
+        final String sha1 = BaseEncoding.base16().lowerCase().encode(digestInputStream.getMessageDigest().digest());
+        assertThat(artifactStoreUnderTest.getArtifactBySha1(tenant, sha1)).isNotNull();
+        return sha1;
    }

    @Test
-    @Description("Ensures that search by MD5 hash finds the expected results.")
-    public void findArtifactByMD5Hash() throws NoSuchAlgorithmException {
-        final int filelengthBytes = 128;
-        final String filename = "testfile.json";
-        final String contentType = "application/json";
+    @Description("Deletes file from repository identified by SHA1 hash as filename.")
+    public void deleteArtifactBySHA1Hash() throws NoSuchAlgorithmException {

-        final DigestInputStream digestInputStream = digestInputStream(generateInputStream(filelengthBytes), "MD5");
-        artifactStoreUnderTest.store(digestInputStream, filename, contentType);
-        assertThat(artifactStoreUnderTest.getArtifactByMd5(
-                BaseEncoding.base16().lowerCase().encode(digestInputStream.getMessageDigest().digest()))).isNotNull();
+        final String sha1 = storeRandomArifactAndVerify(TENANT);
+
+        artifactStoreUnderTest.deleteBySha1(TENANT, sha1);
+        assertThat(artifactStoreUnderTest.getArtifactBySha1(TENANT, sha1)).isNull();
+    }
+
+    @Test
+    @Description("Verfies that all data of a tenant is erased if repository is asked to do so. "
+            + "Data of other tenants is not affected.")
+    public void deleteTenant() throws NoSuchAlgorithmException {
+
+        final String shaDeleted = storeRandomArifactAndVerify(TENANT);
+        final String shaUndeleted = storeRandomArifactAndVerify("another_tenant");
+
+        artifactStoreUnderTest.deleteByTenant("tenant_that_does_not_exist");
+        artifactStoreUnderTest.deleteByTenant(TENANT);
+        assertThat(artifactStoreUnderTest.getArtifactBySha1(TENANT, shaDeleted)).isNull();
+        assertThat(artifactStoreUnderTest.getArtifactBySha1("another_tenant", shaUndeleted)).isNotNull();
    }

    private static ByteArrayInputStream generateInputStream(final int length) {