-
-
Notifications
You must be signed in to change notification settings - Fork 288
Check that jar output is byte-for-byte identical #55
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7bc428b
Check that jar output is byte-for-byte identical
oscar-stripe 8ac7a6f
add bazel's jar creation code
oscar-stripe a6b8fe3
Add a default output to scala_library
oscar-stripe dfb5609
merge master and add fix from #65
oscar-stripe dda9314
Remove unneeded find/touch with new jar code
oscar-stripe a599003
use md5sum not md5 in test
johnynek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| java_binary(name = "jar", | ||
| srcs = ["JarCreator.java", "JarHelper.java"], | ||
| main_class = "io.bazel.rulesscala.jar.JarCreator", | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| // Copyright 2014 The Bazel Authors. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package io.bazel.rulesscala.jar; | ||
|
|
||
| import java.io.BufferedOutputStream; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.io.FileOutputStream; | ||
| import java.io.IOException; | ||
| import java.util.Collection; | ||
| import java.util.Map; | ||
| import java.util.TreeMap; | ||
| import java.util.jar.Attributes; | ||
| import java.util.jar.JarOutputStream; | ||
| import java.util.jar.Manifest; | ||
|
|
||
| /** | ||
| * A class for creating Jar files. Allows normalization of Jar entries by setting their timestamp to | ||
| * the DOS epoch. All Jar entries are sorted alphabetically. | ||
| */ | ||
| public class JarCreator extends JarHelper { | ||
|
|
||
| // Map from Jar entry names to files. Use TreeMap so we can establish a canonical order for the | ||
| // entries regardless in what order they get added. | ||
| private final Map<String, String> jarEntries = new TreeMap<>(); | ||
| private String manifestFile; | ||
| private String mainClass; | ||
|
|
||
| public JarCreator(String fileName) { | ||
| super(fileName); | ||
| } | ||
|
|
||
| /** | ||
| * Adds an entry to the Jar file, normalizing the name. | ||
| * | ||
| * @param entryName the name of the entry in the Jar file | ||
| * @param fileName the name of the input file for the entry | ||
| * @return true iff a new entry was added | ||
| */ | ||
| public boolean addEntry(String entryName, String fileName) { | ||
| if (entryName.startsWith("/")) { | ||
| entryName = entryName.substring(1); | ||
| } else if (entryName.startsWith("./")) { | ||
| entryName = entryName.substring(2); | ||
| } | ||
| return jarEntries.put(entryName, fileName) == null; | ||
| } | ||
|
|
||
| /** | ||
| * Adds the contents of a directory to the Jar file. All files below this | ||
| * directory will be added to the Jar file using the name relative to the | ||
| * directory as the name for the Jar entry. | ||
| * | ||
| * @param directory the directory to add to the jar | ||
| */ | ||
| public void addDirectory(String directory) { | ||
| addDirectory(null, new File(directory)); | ||
| } | ||
|
|
||
| /** | ||
| * Adds the contents of a directory to the Jar file. All files below this | ||
| * directory will be added to the Jar file using the prefix and the name | ||
| * relative to the directory as the name for the Jar entry. Always uses '/' as | ||
| * the separator char for the Jar entries. | ||
| * | ||
| * @param prefix the prefix to prepend to every Jar entry name found below the | ||
| * directory | ||
| * @param directory the directory to add to the Jar | ||
| */ | ||
| private void addDirectory(String prefix, File directory) { | ||
| File[] files = directory.listFiles(); | ||
| if (files != null) { | ||
| for (File file : files) { | ||
| String entryName = prefix != null ? prefix + "/" + file.getName() : file.getName(); | ||
| jarEntries.put(entryName, file.getAbsolutePath()); | ||
| if (file.isDirectory()) { | ||
| addDirectory(entryName, file); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Adds a collection of entries to the jar, each with a given source path, and with | ||
| * the resulting file in the root of the jar. | ||
| * <pre> | ||
| * some/long/path.foo => (path.foo, some/long/path.foo) | ||
| * </pre> | ||
| */ | ||
| public void addRootEntries(Collection<String> entries) { | ||
| for (String entry : entries) { | ||
| jarEntries.put(new File(entry).getName(), entry); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets the main.class entry for the manifest. A value of <code>null</code> | ||
| * (the default) will omit the entry. | ||
| * | ||
| * @param mainClass the fully qualified name of the main class | ||
| */ | ||
| public void setMainClass(String mainClass) { | ||
| this.mainClass = mainClass; | ||
| } | ||
|
|
||
| /** | ||
| * Sets filename for the manifest content. If this is set the manifest will be | ||
| * read from this file otherwise the manifest content will get generated on | ||
| * the fly. | ||
| * | ||
| * @param manifestFile the filename of the manifest file. | ||
| */ | ||
| public void setManifestFile(String manifestFile) { | ||
| this.manifestFile = manifestFile; | ||
| } | ||
|
|
||
| private byte[] manifestContent() throws IOException { | ||
| Manifest manifest; | ||
| if (manifestFile != null) { | ||
| FileInputStream in = new FileInputStream(manifestFile); | ||
| manifest = new Manifest(in); | ||
| } else { | ||
| manifest = new Manifest(); | ||
| } | ||
| Attributes attributes = manifest.getMainAttributes(); | ||
| attributes.put(Attributes.Name.MANIFEST_VERSION, "1.0"); | ||
| Attributes.Name createdBy = new Attributes.Name("Created-By"); | ||
| if (attributes.getValue(createdBy) == null) { | ||
| attributes.put(createdBy, "blaze"); | ||
| } | ||
| if (mainClass != null) { | ||
| attributes.put(Attributes.Name.MAIN_CLASS, mainClass); | ||
| } | ||
| ByteArrayOutputStream out = new ByteArrayOutputStream(); | ||
| manifest.write(out); | ||
| return out.toByteArray(); | ||
| } | ||
|
|
||
| /** | ||
| * Executes the creation of the Jar file. | ||
| * | ||
| * @throws IOException if the Jar cannot be written or any of the entries | ||
| * cannot be read. | ||
| */ | ||
| public void execute() throws IOException { | ||
| out = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(jarFile))); | ||
|
|
||
| // Create the manifest entry in the Jar file | ||
| writeManifestEntry(manifestContent()); | ||
| try { | ||
| for (Map.Entry<String, String> entry : jarEntries.entrySet()) { | ||
| copyEntry(entry.getKey(), new File(entry.getValue())); | ||
| } | ||
| } finally { | ||
| out.closeEntry(); | ||
| out.close(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A simple way to create Jar file using the JarCreator class. | ||
| */ | ||
| public static void main(String[] args) { | ||
| if (args.length < 1) { | ||
| System.err.println("usage: CreateJar [-m manifest] output [root directories]"); | ||
| System.exit(1); | ||
| } | ||
|
|
||
| int idx = 0; | ||
| String manifestFile = null; | ||
| if (args[0].equals("-m")) { | ||
| manifestFile = args[1]; | ||
| idx = 2; | ||
| } | ||
| String output = args[idx]; | ||
| JarCreator createJar = new JarCreator(output); | ||
| createJar.setManifestFile(manifestFile); | ||
| for (int i = (idx+1); i < args.length; i++) { | ||
| createJar.addDirectory(args[i]); | ||
| } | ||
| createJar.setCompression(true); | ||
| createJar.setNormalize(true); | ||
| long start = System.currentTimeMillis(); | ||
| try { | ||
| createJar.execute(); | ||
| } catch (Throwable e) { | ||
| e.printStackTrace(); | ||
| System.exit(1); | ||
| } | ||
| long stop = System.currentTimeMillis(); | ||
| //System.err.println((stop - start) + "ms."); | ||
| //System.err.println(output); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW, @bazel_tools//tools/zip:zipper is a zip implementation that strip out timestamp. Might be easier to refer to it that to fork SingleJar's Jar implementation. (Also faster)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is good to know about instead of using system
zip, but what about making manifests? Seems nice to reuse that bit?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I see, then maybe you can use directly the SingleJar binary. Just ask if you need to get rid of the file fork and I can probably help you sort that out.