Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define constants instead of using String literals #3402

Merged
merged 3 commits into from
Aug 10, 2021
Merged

Define constants instead of using String literals #3402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d68ba69
Define a constant instead of using String literals
mpeddada1 Aug 10, 2021
2865af8
clean up
mpeddada1 Aug 10, 2021
c447f16
fix formatting
mpeddada1 Aug 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions jib-cli/src/main/java/com/google/cloud/tools/jib/cli/jar/SpringBootExplodedProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@

public class SpringBootExplodedProcessor implements ArtifactProcessor {

private static final String BOOT_INF = "BOOT-INF";

private final Path jarPath;
private final Path targetExplodedJarRoot;
private final Integer jarJavaVersion;
Expand Down Expand Up @@ -69,7 +71,7 @@ public List<FileEntriesLayer> createLayers() throws IOException {

try (JarFile jarFile = new JarFile(jarPath.toFile())) {
ZipUtil.unzip(jarPath, targetExplodedJarRoot, true);
ZipEntry layerIndex = jarFile.getEntry("BOOT-INF/layers.idx");
ZipEntry layerIndex = jarFile.getEntry(BOOT_INF + "/layers.idx");
if (layerIndex != null) {
return createLayersForLayeredSpringBootJar(targetExplodedJarRoot);
}
Expand All @@ -78,7 +80,7 @@ public List<FileEntriesLayer> createLayers() throws IOException {

// Non-snapshot layer
Predicate<Path> isInBootInfLib =
path -> path.startsWith(targetExplodedJarRoot.resolve("BOOT-INF").resolve("lib"));
path -> path.startsWith(targetExplodedJarRoot.resolve(BOOT_INF).resolve("lib"));
Predicate<Path> isSnapshot = path -> path.getFileName().toString().contains("SNAPSHOT");
Predicate<Path> isInBootInfLibAndIsNotSnapshot = isInBootInfLib.and(isSnapshot.negate());
Predicate<Path> nonSnapshotPredicate = isFile.and(isInBootInfLibAndIsNotSnapshot);
Expand Down Expand Up @@ -109,7 +111,7 @@ public List<FileEntriesLayer> createLayers() throws IOException {
// Classes layer.
Predicate<Path> isClass = path -> path.getFileName().toString().endsWith(".class");
Predicate<Path> isInBootInfClasses =
path -> path.startsWith(targetExplodedJarRoot.resolve("BOOT-INF").resolve("classes"));
path -> path.startsWith(targetExplodedJarRoot.resolve(BOOT_INF).resolve("classes"));
Predicate<Path> classesPredicate = isInBootInfClasses.and(isClass);
FileEntriesLayer classesLayer =
ArtifactLayers.getDirectoryContentsAsLayer(
Expand Down Expand Up @@ -158,7 +160,7 @@ public Integer getJavaVersion() {
*/
private static List<FileEntriesLayer> createLayersForLayeredSpringBootJar(
Path localExplodedJarRoot) throws IOException {
Path layerIndexPath = localExplodedJarRoot.resolve("BOOT-INF").resolve("layers.idx");
Path layerIndexPath = localExplodedJarRoot.resolve(BOOT_INF).resolve("layers.idx");
Pattern layerNamePattern = Pattern.compile("- \"(.*)\":");
Pattern layerEntryPattern = Pattern.compile(" - \"(.*)\"");
Map<String, List<String>> layersMap = new LinkedHashMap<>();
Expand Down
13 changes: 6 additions & 7 deletions jib-core/src/main/java/com/google/cloud/tools/jib/api/ImageReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public class ImageReference {
private static final String DOCKER_HUB_REGISTRY = "registry-1.docker.io";
private static final String DEFAULT_TAG = "latest";
private static final String LIBRARY_REPOSITORY_PREFIX = "library/";
private static final String SCRATCH = "scratch";

/**
* Matches all sequences of alphanumeric characters possibly separated by any number of dashes in
Expand Down Expand Up @@ -94,7 +95,7 @@ public class ImageReference {
* @throws InvalidImageReferenceException if {@code reference} is formatted incorrectly
*/
public static ImageReference parse(String reference) throws InvalidImageReferenceException {
if (reference.equals("scratch")) {
if (reference.equals(SCRATCH)) {
return ImageReference.scratch();
}

Expand Down Expand Up @@ -204,7 +205,7 @@ public static ImageReference of(
* to "scratch"
*/
public static ImageReference scratch() {
return new ImageReference("", "scratch", null, null);
return new ImageReference("", SCRATCH, null, null);
}

/**
Expand Down Expand Up @@ -270,9 +271,7 @@ public static boolean isDefaultTag(@Nullable String tag) {
private ImageReference(
String registry, String repository, @Nullable String tag, @Nullable String digest) {
Preconditions.checkArgument(
"scratch".equals(repository)
|| !Strings.isNullOrEmpty(tag)
|| !Strings.isNullOrEmpty(digest),
SCRATCH.equals(repository) || !Strings.isNullOrEmpty(tag) || !Strings.isNullOrEmpty(digest),
"Either tag or digest needs to be set.");
this.registry = RegistryAliasGroup.getHost(registry);
this.repository = repository;
Expand Down Expand Up @@ -345,7 +344,7 @@ public boolean usesDefaultTag() {
*/
public boolean isScratch() {
return "".equals(registry)
&& "scratch".equals(repository)
&& SCRATCH.equals(repository)
&& Strings.isNullOrEmpty(tag)
&& Strings.isNullOrEmpty(digest);
}
Expand Down Expand Up @@ -395,7 +394,7 @@ public String toStringWithQualifier() {
*/
private String toString(boolean singleQualifier) {
if (isScratch()) {
return "scratch";
return SCRATCH;
}

StringBuilder referenceString = new StringBuilder();
Expand Down
8 changes: 5 additions & 3 deletions jib-core/src/main/java/com/google/cloud/tools/jib/image/ImageTarball.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ public class ImageTarball {
/** Time that entry is set in the tar. */
private static final Instant TAR_ENTRY_MODIFICATION_TIME = Instant.EPOCH;

private static final String BLOB_PREFIX = "blobs/sha256/";

private final Image image;
private final ImageReference imageReference;
private final ImmutableSet<String> allTargetImageTags;
Expand Down Expand Up @@ -93,7 +95,7 @@ private void ociWriteTo(OutputStream out) throws IOException {
long size = layer.getBlobDescriptor().getSize();

tarStreamBuilder.addBlobEntry(
layer.getBlob(), size, "blobs/sha256/" + digest.getHash(), TAR_ENTRY_MODIFICATION_TIME);
layer.getBlob(), size, BLOB_PREFIX + digest.getHash(), TAR_ENTRY_MODIFICATION_TIME);
manifest.addLayer(size, digest);
}

Expand All @@ -104,14 +106,14 @@ private void ociWriteTo(OutputStream out) throws IOException {
manifest.setContainerConfiguration(configDescriptor.getSize(), configDescriptor.getDigest());
tarStreamBuilder.addByteEntry(
JsonTemplateMapper.toByteArray(containerConfiguration),
"blobs/sha256/" + configDescriptor.getDigest().getHash(),
BLOB_PREFIX + configDescriptor.getDigest().getHash(),
TAR_ENTRY_MODIFICATION_TIME);

// Adds the manifest to the tarball
BlobDescriptor manifestDescriptor = Digests.computeDigest(manifest);
tarStreamBuilder.addByteEntry(
JsonTemplateMapper.toByteArray(manifest),
"blobs/sha256/" + manifestDescriptor.getDigest().getHash(),
BLOB_PREFIX + manifestDescriptor.getDigest().getHash(),
TAR_ENTRY_MODIFICATION_TIME);

// Adds the oci-layout and index.json
Expand Down
8 changes: 5 additions & 3 deletions ...n/src/main/java/com/google/cloud/tools/jib/plugins/common/JavaContainerBuilderHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@
/** Helper for constructing {@link JavaContainerBuilder}-based {@link JibContainerBuilder}s. */
public class JavaContainerBuilderHelper {

private static final String GLOB_PREFIX = "glob:";

/**
* Returns a {@link FileEntriesLayer} for adding the extra directory to the container.
*
Expand All @@ -67,21 +69,21 @@ public static FileEntriesLayer extraDirectoryLayerConfiguration(
Map<PathMatcher, FilePermissions> permissionsPathMatchers = new LinkedHashMap<>();
for (Map.Entry<String, FilePermissions> entry : extraDirectoryPermissions.entrySet()) {
permissionsPathMatchers.put(
FileSystems.getDefault().getPathMatcher("glob:" + entry.getKey()), entry.getValue());
FileSystems.getDefault().getPathMatcher(GLOB_PREFIX + entry.getKey()), entry.getValue());
}

DirectoryWalker walker = new DirectoryWalker(sourceDirectory).filterRoot();
// add exclusion filters
excludes
.stream()
.map(pattern -> FileSystems.getDefault().getPathMatcher("glob:" + pattern))
.map(pattern -> FileSystems.getDefault().getPathMatcher(GLOB_PREFIX + pattern))
.forEach(
pathMatcher ->
walker.filter(path -> !pathMatcher.matches(sourceDirectory.relativize(path))));
// add an inclusion filter
includes
.stream()
.map(pattern -> FileSystems.getDefault().getPathMatcher("glob:" + pattern))
.map(pattern -> FileSystems.getDefault().getPathMatcher(GLOB_PREFIX + pattern))
.map(
pathMatcher ->
(Predicate<Path>) path -> pathMatcher.matches(sourceDirectory.relativize(path)))
Expand Down