Fix empty folder missing problem when zip files.

[counter2015]

Fix: #328

[lefou]

Thank you for your contribution.

First, I'd prefer to have separate pull requests for unrelated changes.

About the empty dir handling of zip files. I think it's a good idea to add an option/parameter to let the user decide whether to include directory entries or not. Enabling it could be the default, since it's what most users would expect.

[counter2015]

@lefou okay, let me separate this pull request to two.

[counter2015]

I'd like to do some "linting" works on #331 firstly.

[lihaoyi]

Let's just do the zip file changes, no need all the english grammar improvements and other random build config tweaks.

[lihaoyi]

Why are we using String here?

[counter2015]

Because treats a ZipEntry as directory if its name ends with "/" characters.
Firstly I want to add end "/" character, but in os.Path it's not valid.

[counter2015]

I know it's not a good way to implement, since it breaks the type check inside os.Path, could you give me some advice ?
should I rewrite another method to handle folders such like makeZipFolderEntry0 ?

[lihaoyi]

We should be able to keep the conversion to string and appending of / inside makeZipEntry0. is: Option should already tell us whether it's a file or directory I think

[counter2015]

Done. But I'm afraid This might be a little slightly fragile assumption, since it's relied on

val fis = if (os.isFile(file)) Some(os.read.inputStream(file)) else None

[counter2015]

Does format checking relies on OS system ?
In CI environment , I found

======================================================================================================================
1 tasks failed
mill.scalalib.scalafmt.ScalafmtModule.checkFormatAll Found 6 misformatted files
Error: Process completed with exit code 1.

In my local windows git bash environment

./mill -i mill.scalalib.scalafmt.ScalafmtModule/checkFormatAll __.sources
[60/60] =============================================== mill.scalalib.scalafmt.ScalafmtModule/checkFormatAll __.sources =============================================== 21s
1 tasks failed
mill.scalalib.scalafmt.ScalafmtModule.checkFormatAll Found 253 misformatted files

one is 6 but another one is 253.

[counter2015]

In CI Test

X test.os.ZipOpTests.unzipExcludePatterns 13ms 
[2205]   utest.AssertionError: paths == expected
[2205]   paths: IndexedSeq[os.Path] = ArraySeq(/Users/runner/work/os-lib/os-lib/out/mill-no-server/d4325d17/sandbox/out/scratch/ZipOpTests/tests/unzipExcludePatterns/unzipAllExceptExcludingCertainFiles/File.txt, /Users/runner/work/os-lib/os-lib/out/mill-no-server/d4325d17/sandbox/out/scratch/ZipOpTests/tests/unzipExcludePatterns/unzipAllExceptExcludingCertainFiles/folder1, /Users/runner/work/os-lib/os-lib/out/mill-no-server/d4325d17/sandbox/out/scratch/ZipOpTests/tests/unzipExcludePatterns/unzipAllExceptExcludingCertainFiles/one.txt)
[2205]   expected: Seq[os.Path] = List(/Users/runner/work/os-lib/os-lib/out/mill-no-server/d4325d17/sandbox/out/scratch/ZipOpTests/tests/unzipExcludePatterns/unzipAllExceptExcludingCertainFiles/File.txt, /Users/runner/work/os-lib/os-lib/out/mill-no-server/d4325d17/sandbox/out/scratch/ZipOpTests/tests/unzipExcludePatterns/unzipAllExceptExcludingCertainFiles/one.txt, /Users/runner/work/os-lib/os-lib/out/mill-no-server/d4325d17/sandbox/out/scratch/ZipOpTests/tests/unzipExcludePatterns/folder1)

to simplify, paths is ArraySeq(File.txt, folder1, one.txt) while expected is Seq(File.txt, one.text, folder1), It seems that we should fix flaky test, sort the result before comparing ?

[lihaoyi]

@counter2015 yes adding a sort seems reasonable

[counter2015]

I found the test report depends on old commit, seems some weird caching issues in CI environment.

For example.

[1487] X test.os.CheckerTests.unzip 25ms 
[1487]   java.lang.AssertionError: assertion failed: ==> assertion failed: 3 != 2
[1487]     scala.Predef$.assert(Predef.scala:223)
[1487]     utest.asserts.Asserts$ArrowAssert.$eq$eq$greater(Asserts.scala:90)
[1487]     test.os.CheckerTests$.$anonfun$tests$99(CheckerTests.scala:481)
[1487]     test.os.CheckerTests$.$anonfun$tests$99$adapted(CheckerTests.scala:459)
[1487]     test.os.TestUtil$.$anonfun$prepChecker$2(TestUtil.scala:81)
[1487]     scala.util.DynamicVariable.withValue(DynamicVariable.scala:62)
[1487]     test.os.TestUtil$.$anonfun$prepChecker$1(TestUtil.scala:81)
[1487]     test.os.TestUtil$.prep(TestUtil.scala:77)
[1487]     test.os.TestUtil$.prepChecker(TestUtil.scala:81)
[1487]     test.os.CheckerTests$.$anonfun$tests$98(CheckerTests.scala:459)

for new test code

val unzipDir = os.unzip(
        source = zipFile,
        dest = wd / "unzipped"
      )
      os.walk(unzipDir).length ==> 3

Maybe we should re-run the CI command ?