#378

Committed 29 Apr 2025 01:00PM UTC coverage: 86.311%. First build

Build # #378

Build Type

Pull #233

github

Committed by

web-flow

Commit Message

Merge pull request #253 from kit-data-manager/fix-renaming-of-data-set-entities

Fix renaming of data set entities

Pull Request Pull Request #233: Version 2.1.0

Run Details

598 of 763 new or added lines in 29 files covered. (78.37%)

1879 of 2177 relevant lines covered (86.31%)

0.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.31

/src/main/java/edu/kit/datamanager/ro_crate/writer/ZipStrategy.java

package edu.kit.datamanager.ro_crate.writer;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import edu.kit.datamanager.ro_crate.Crate;
import edu.kit.datamanager.ro_crate.entities.data.DataEntity;
import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
import net.lingala.zip4j.ZipFile;
import net.lingala.zip4j.exception.ZipException;
import net.lingala.zip4j.model.ZipParameters;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;

/**
 * Implementation of the writing strategy to provide a way of writing crates to
 * a zip archive.
 */
public class ZipStrategy implements GenericWriterStrategy<String> {

    private static final Logger logger = LoggerFactory.getLogger(ZipStrategy.class);

    @Override
    public void save(Crate crate, String destination) {
        try (ZipFile zipFile = new ZipFile(destination)) {
            saveMetadataJson(crate, zipFile);
            saveDataEntities(crate, zipFile);
        } catch (IOException e) {
            // can not close ZipFile (threw Exception)
            logger.error("Failed to write ro-crate to destination " + destination + ".", e);
        }
    }

    private void saveDataEntities(Crate crate, ZipFile zipFile) {
        for (DataEntity dataEntity : crate.getAllDataEntities()) {
            try {
                dataEntity.saveToZip(zipFile);
            } catch (ZipException e) {
                logger.error("Could not save " + dataEntity.getId() + " to zip file!", e);
            }
        }
    }

    private void saveMetadataJson(Crate crate, ZipFile zipFile) {
        // write the metadata.json file
        ZipParameters zipParameters = new ZipParameters();
        zipParameters.setFileNameInZip("ro-crate-metadata.json");
        ObjectMapper objectMapper = MyObjectMapper.getMapper();
        try {
            // we create an JsonNode only to have the file written pretty
            JsonNode node = objectMapper.readTree(crate.getJsonMetadata());
            String str = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(node);
            try (InputStream inputStream = new ByteArrayInputStream(str.getBytes(StandardCharsets.UTF_8))) {
                // write the ro-crate-metadata
                zipFile.addStream(inputStream, zipParameters);
            }
            if (crate.getPreview() != null) {
                crate.getPreview().saveAllToZip(zipFile);
            }
        } catch (IOException e) {
            logger.error("Exception writing ro-crate-metadata.json file to zip.", e);
        }
    }
}

1	package edu.kit.datamanager.ro_crate.writer;
2
3	import com.fasterxml.jackson.databind.JsonNode;
4	import com.fasterxml.jackson.databind.ObjectMapper;
5	import edu.kit.datamanager.ro_crate.Crate;
6	import edu.kit.datamanager.ro_crate.entities.data.DataEntity;
7	import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
8	import net.lingala.zip4j.ZipFile;
9	import net.lingala.zip4j.exception.ZipException;
10	import net.lingala.zip4j.model.ZipParameters;
11	import org.slf4j.Logger;
12	import org.slf4j.LoggerFactory;
13
14	import java.io.ByteArrayInputStream;
15	import java.io.IOException;
16	import java.io.InputStream;
17	import java.nio.charset.StandardCharsets;
18
19	/**
20	* Implementation of the writing strategy to provide a way of writing crates to
21	* a zip archive.
22	*/
23	public class ZipStrategy implements GenericWriterStrategy<String> {	1✔
24
25	private static final Logger logger = LoggerFactory.getLogger(ZipStrategy.class);	1✔
26
27	@Override
28	public void save(Crate crate, String destination) {
29	try (ZipFile zipFile = new ZipFile(destination)) {	1✔
30	saveMetadataJson(crate, zipFile);	1✔
31	saveDataEntities(crate, zipFile);	1✔
NEW 32	} catch (IOException e) {	×
33	// can not close ZipFile (threw Exception)
NEW 34	logger.error("Failed to write ro-crate to destination " + destination + ".", e);	×
35	}	1✔
36	}	1✔
37
38	private void saveDataEntities(Crate crate, ZipFile zipFile) {
39	for (DataEntity dataEntity : crate.getAllDataEntities()) {	1✔
40	try {
41	dataEntity.saveToZip(zipFile);	1✔
NEW 42	} catch (ZipException e) {	×
NEW 43	logger.error("Could not save " + dataEntity.getId() + " to zip file!", e);	×
44	}	1✔
45	}	1✔
46	}	1✔
47
48	private void saveMetadataJson(Crate crate, ZipFile zipFile) {
49	// write the metadata.json file
50	ZipParameters zipParameters = new ZipParameters();	1✔
51	zipParameters.setFileNameInZip("ro-crate-metadata.json");	1✔
52	ObjectMapper objectMapper = MyObjectMapper.getMapper();	1✔
53	try {
54	// we create an JsonNode only to have the file written pretty
55	JsonNode node = objectMapper.readTree(crate.getJsonMetadata());	1✔
56	String str = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(node);	1✔
57	try (InputStream inputStream = new ByteArrayInputStream(str.getBytes(StandardCharsets.UTF_8))) {	1✔
58	// write the ro-crate-metadata
59	zipFile.addStream(inputStream, zipParameters);	1✔
60	}
61	if (crate.getPreview() != null) {	1✔
62	crate.getPreview().saveAllToZip(zipFile);	1✔
63	}
NEW 64	} catch (IOException e) {	×
NEW 65	logger.error("Exception writing ro-crate-metadata.json file to zip.", e);	×
66	}	1✔
67	}	1✔
68	}

kit-data-manager / ro-crate-java / #378

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous