allow archive targets to eliminate top-level directory

[easel]

See http://stackoverflow.com/questions/20133164/why-does-sbt-native-packager-generate-a-hardcoded-top-level-parent-directory-in for more details.

One use case. Trying to use the output from packageBin to deploy a docker file to elastic beanstalk fails because elastic beanstalk expects to find the Dockerfile in the root of the .zip file.

[muuki88]

I'm not quite sure about this one. So that I got everything right. The current behaviour is

unzip example-app.zip
> example-app/lib
> example-app/conf
> example-app/bin

And you expect

unzip example-app.zip
> lib
> conf
> bin

From a usability perspective I think it's not a good idea. Repackaging that script with a small bash or sbt script would be a workaround. You can also provide a pull request which makes this behavior configurable. Take a look at Archives.scala

If you are a bit patient, you can wait for the native docker support from native-packager #236

[easel]

You're understanding the use case correctly. I'm comfortable making the change permanent, but less sure how you guys would prefer to see it configured. If you can point me in the right direction on that front I can take a shot at making a pull request.

[muuki88]

Sure :)

The configuration should be inside the ../packager/universal package. Defining a SettingsKey withTopLevelDirectory (if you have a better name, go ahead), which should by default be true (set this here)

This setting must be used here. So the logic should rather simple in makeZip, makeNativeZip and makeTarball

// old code
// val m2 = mappings map { case (f, p) => f -> (name + "/" + p) }
val m2 = if(withTopLevelDirectory) mappings map { case (f, p) => f -> (name + "/" + p) } else mappings

[jsuereth]

This solution looks pretty good to me. Note: I think it may also have to hit the DMG support we have....

[prascuna]

Hi, any hint about how to achieve the same result, even if that means uncompressing the zip and recompressing it?

[easel]

This is how I did it in my build.sbt:

/* Override the packageBin target to eliminate the top-level folder */
packageBin <<= (baseDirectory, packageBin in Universal, mappings in packageBin in Universal,     streams) map
  { (bd, artifactPath, mappings, s: TaskStreams) =>
    s.log.info(s"Creating $artifactPath")
    ZipHelper.zip(mappings, artifactPath)
    artifactPath
  } dependsOn stage

[muuki88]

thanks for sharing @easel

[prascuna]

Thanks @easel
You solution looks great, but unfortunately I'm not familiar enough with sbt to understand why your suggestion doesn't work for me (sbt 0.13 , sbt-native-packager 0.8.0). The output is the same old zip file, with top-level folder included

The solution that I'm using right now (ugly, redundant and incomplete, since it doesn't handle the tgz) is this:

packageBin in Universal := {
    val originalFileName = (packageBin in Universal).value
    val (base, ext) = originalFileName.baseAndExt
    val newFileName = file(originalFileName.getParent) / (base + "_dist." + ext)
    val extractedFiles = IO.unzip(originalFileName,file(originalFileName.getParent))
    val mappings: Set[(File, String)] = extractedFiles.map( f => (f, f.getAbsolutePath.substring(originalFileName.getParent.size + base.size + 2)))
    val binFiles = mappings.filter{ case (file, path) => path.startsWith("bin/")}
    for (f <- binFiles) f._1.setExecutable(true)
    ZipHelper.zip(mappings,newFileName)
    IO.move(newFileName, originalFileName)
    IO.delete(file(originalFileName.getParent +  "/" + originalFileName.base))
    originalFileName
}

I basically extract the zip, and compress it again, preserving the executable permissions of the bin folder

[jdeastwood]

@muuki88 Ha, I was just starting to look at implementing your suggestion above for packaging a samza job, only to find you've committed a fix! Thanks!

@prascuna doubtless you are more observant than I, but I was struggling to get @easel's solution working as well before I noticed he overwrote the top-level packageBin, not universal:packageBin as you did.

[muuki88]

I'll just add some docs and then I'll pull off a release hopefully this weekend :)