Windows Executables

.editorconfig

@@ -6,7 +6,6 @@ root = true
 # global rules for all fies
 [*]
 charset = utf-8
-end_of_line = lf
 indent_style = space
 trim_trailing_whitespace = true
 

.github/workflows/release.yml

@@ -78,8 +78,6 @@ jobs:
         name: Clone Git Repository
         if: needs.prepare.outputs.commit_count > 0
         uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - id: graal
         name: GraalVM Setup
         if: needs.prepare.outputs.commit_count > 0
@@ -183,8 +181,6 @@ jobs:
         name: Clone Git Repository
         if: needs.prepare.outputs.commit_count > 0
         uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - id: graal
         name: GraalVM Setup
         if: needs.prepare.outputs.commit_count > 0
@@ -248,9 +244,94 @@ jobs:
           asset_path: ./target/ilo-${{ needs.prepare.outputs.release_version }}-mac.zip.asc
           asset_name: ilo-${{ needs.prepare.outputs.release_version }}-mac.zip.asc
           asset_content_type: text/plain
+  windows:
+    name: Windows packages
+    needs: prepare
+    runs-on: windows-latest
+    steps:
+      - id: checkout
+        name: Clone Git Repository
+        if: needs.prepare.outputs.commit_count > 0
+        uses: actions/checkout@v2
+      - id: graal-download
+        name: GraalVM Download
+        if: needs.prepare.outputs.commit_count > 0
+        run: Invoke-RestMethod -Uri https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-${{ env.GRAAL }}/graalvm-ce-${{ env.JAVA }}-windows-amd64-${{ env.GRAAL }}.zip -OutFile 'graal.zip'
+      - id: graal-expand
+        name: Install GraalVM
+        if: needs.prepare.outputs.commit_count > 0
+        run: Expand-Archive -path 'graal.zip' -destinationpath '.'
+      - id: native-image
+        name: Install native-image
+        if: needs.prepare.outputs.commit_count > 0
+        run: graalvm-ce-${{ env.JAVA }}-${{ env.GRAAL }}\bin\gu.cmd install native-image
+      - id: cache
+        name: Cache Maven Repository
+        if: needs.prepare.outputs.commit_count > 0
+        uses: actions/cache@v1
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - id: gpg
+        name: GPG Key
+        if: needs.prepare.outputs.commit_count > 0
+        uses: timheuer/base64-to-file@v1.0.3
+        with:
+          fileName: signing.key.asc
+          encodedString: ${{ secrets.GPG_KEY }}
+      - id: copy-key
+        name: Copy GPG key to correct location
+        if: needs.prepare.outputs.commit_count > 0
+        run: Copy-Item -Path "${{ steps.gpg.outputs.filePath }}" -Destination "$env:GITHUB_WORKSPACE\signing.key.asc"
+      - id: verify
+        name: Verify Project
+        if: needs.prepare.outputs.commit_count > 0
+        shell: cmd
+        run: |
+          call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x86_amd64
+          mvn --batch-mode --settings .\build\settings.xml verify -Dskip.graal=false -Dpit.skip=true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GPG_KEY_PASSPHRASE: ${{ secrets.GPG_KEY_PASSPHRASE }}
+          JAVA_HOME: ./graalvm-ce-${{ env.JAVA }}-${{ env.GRAAL }}
+      - id: upload-windows-artifact
+        name: Upload Windows Artifact
+        if: needs.prepare.outputs.commit_count > 0
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.prepare.outputs.release_url }}
+          asset_path: ./target/ilo-${{ needs.prepare.outputs.release_version }}-windows.zip
+          asset_name: ilo-${{ needs.prepare.outputs.release_version }}-windows.zip
+          asset_content_type: application/zip
+      - id: upload-windows-checksum
+        name: Upload Windows Checksum
+        if: needs.prepare.outputs.commit_count > 0
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.prepare.outputs.release_url }}
+          asset_path: ./target/ilo-${{ needs.prepare.outputs.release_version }}-windows.zip.sha512
+          asset_name: ilo-${{ needs.prepare.outputs.release_version }}-windows.zip.sha512
+          asset_content_type: text/plain
+      - id: upload-windows-signature
+        name: Upload Windows Signature
+        if: needs.prepare.outputs.commit_count > 0
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.prepare.outputs.release_url }}
+          asset_path: ./target/ilo-${{ needs.prepare.outputs.release_version }}-windows.zip.asc
+          asset_name: ilo-${{ needs.prepare.outputs.release_version }}-windows.zip.asc
+          asset_content_type: text/plain
   announce:
     name: Release Announcement
-    needs: [prepare, linux, mac]
+    needs: [prepare, linux, mac, windows]
     runs-on: ubuntu-latest
     steps:
       - id: email

.github/workflows/verify.yml

@@ -17,8 +17,6 @@ jobs:
       - id: checkout
         name: Clone Git Repository
         uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - id: graal
         name: GraalVM Setup
         uses: rinx/setup-graalvm-ce@v0.0.4
@@ -60,8 +58,6 @@ jobs:
       - id: checkout
         name: Clone Git Repository
         uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - id: graal
         name: GraalVM Setup
         uses: DeLaGuardo/setup-graalvm@2.0
@@ -91,4 +87,52 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: mac
-          path: ./target/ilo-*-mac*
+          path: ./target/ilo-*-mac*
+  windows:
+    name: Windows packages
+    runs-on: windows-latest
+    steps:
+      - id: checkout
+        name: Clone Git Repository
+        uses: actions/checkout@v2
+      - id: graal-download
+        name: GraalVM Download
+        run: Invoke-RestMethod -Uri https://github.com/graalvm/graalvm-ce-builds/releases/download/vm-${{ env.GRAAL }}/graalvm-ce-${{ env.JAVA }}-windows-amd64-${{ env.GRAAL }}.zip -OutFile 'graal.zip'
+      - id: graal-expand
+        name: Install GraalVM
+        run: Expand-Archive -path 'graal.zip' -destinationpath '.'
+      - id: native-image
+        name: Install native-image
+        run: graalvm-ce-${{ env.JAVA }}-${{ env.GRAAL }}\bin\gu.cmd install native-image
+      - id: cache
+        name: Cache Maven Repository
+        uses: actions/cache@v1
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - id: gpg
+        name: GPG Key
+        uses: timheuer/base64-to-file@v1.0.3
+        with:
+          fileName: signing.key.asc
+          encodedString: ${{ secrets.GPG_KEY }}
+      - id: copy-key
+        name: Copy GPG key to correct location
+        run: Copy-Item -Path "${{ steps.gpg.outputs.filePath }}" -Destination "$env:GITHUB_WORKSPACE\signing.key.asc"
+      - id: verify
+        name: Verify Project
+        shell: cmd
+        run: |
+          call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x86_amd64
+          mvn --batch-mode --settings .\build\settings.xml verify -Dskip.graal=false -Dpit.skip=true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GPG_KEY_PASSPHRASE: ${{ secrets.GPG_KEY_PASSPHRASE }}
+          JAVA_HOME: ./graalvm-ce-${{ env.JAVA }}-${{ env.GRAAL }}
+      - name: Upload Windows Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: windows
+          path: ./target/ilo-*-windows*

docs/content/usage/install.md

@@ -30,7 +30,7 @@ The [Linux](https://www.kernel.org/) distribution of `ilo` is a native executabl
 [Fedora](https://getfedora.org/) users can install `ilo` from a [COPR](https://copr.fedorainfracloud.org/coprs/sebhoss/ilo/) repository like this:
 
 ```shell script
-$ sudo dnf copr enable sebhoss/ilo 
+$ sudo dnf copr enable sebhoss/ilo
 $ sudo dnf install ilo
 ```
 
@@ -52,7 +52,7 @@ The [MacOS](https://www.apple.com/macos/) distribution of `ilo` is a native exec
 
 ## Windows
 
-The [Windows](https://www.microsoft.com/en-us/windows) distribution of `ilo` requires at least [Java 11](https://www.oracle.com/javadownload) to be installed.
+The [Windows](https://www.microsoft.com/en-us/windows) distribution of `ilo` is a native executable and does not require any additional software to be installed.
 
 **THIS IS UNTESTED** - [help us](https://github.com/metio/ilo/issues/46) to get this working.
 

docs/layouts/shortcodes/windowsinstall.html

@@ -5,12 +5,13 @@
   ~ in the LICENSE file.
   -->
 
-<div class="highlight"><pre class="chroma"><code class="language-shell" data-lang="shell">$ MD %USERPROFILE%\bin
-$ control sysdm.cpl <span class="c1"># manually add '%USERPROFILE%\bin' to the PATH of your user account</span>
-$ cd /path/to/ilo/installation/folder
-$ curl --location https://github.com/metio/ilo/releases/download/{{ getenv "ILO_RELEASE" }}/ilo-{{ getenv "ILO_RELEASE" }}-java11.zip --output ilo.zip
-$ unzip ilo.zip
-$ chmod +x ilo-{{ getenv "ILO_RELEASE" }}/ilo
-$ ln --symbolic --relative ilo-{{ getenv "ILO_RELEASE" }}/ilo %USERPROFILE%\bin\ilo.bat
+<div class="highlight"><pre class="chroma"><code class="language-shell" data-lang="shell"><span class="c1"># PowerShell</span>
+$ New-Item -Path $env:USERPROFILE -Name "bin" -ItemType "directory" <span class="c1"># create directory if it does not exit</span>
+$ control sysdm.cpl <span class="c1"># manually add '$env:USERPROFILE\bin' to the PATH of your user account</span>
+$ echo $env:PATH <span class="c1"># ensure that the 'bin' directory is in your PATH</span>
+$ Set-Location -Path C:\path\to\ilo\installation\folder
+$ Invoke-RestMethod -Uri https://github.com/metio/ilo/releases/download/{{ getenv "ILO_RELEASE" }}/ilo-{{ getenv "ILO_RELEASE" }}-windows.zip -OutFile "ilo.zip"
+$ Expand-Archive -Path "ilo.zip" -DestinationPath "."
+$ Copy-Item -Path "ilo-{{ getenv "ILO_RELEASE" }}\ilo.exe" -Destination "$env:USERPROFILE\bin\ilo.exe"
 </code></pre>
 </div>

pom.xml

@@ -357,8 +357,16 @@
                 </executions>
                 <configuration>
                     <excludes>
+                        <!-- lots of false-positives? TODO: investigate and fix -->
                         <exclude>docs/**/*</exclude>
+                        <!-- exclude for GitHub Actions -->
+                        <exclude>signing.key.asc</exclude>
                     </excludes>
+                    <includes>
+                        <include>pom.xml</include>
+                        <include>maven-version-rules.xml</include>
+                        <include>src/**/*</include>
+                    </includes>
                 </configuration>
             </plugin>
         </plugins>

src/main/assembly/windows.xml

@@ -20,7 +20,7 @@
             <directory>${project.build.directory}</directory>
             <outputDirectory/>
             <includes>
-                <include>ilo</include>
+                <include>ilo.exe</include>
             </includes>
         </fileSet>
         <fileSet>

src/test/java/wtf/metio/ilo/cli/ExecutablesTest.java

@@ -36,7 +36,6 @@ void shouldDetectToolInPath() {
   }
 
   @Test
-  @EnabledOnOs({OS.LINUX, OS.MAC, OS.WINDOWS})
   @DisplayName("Should detect missing tool in PATH")
   void shouldHandleMissingTool() {
     // given
@@ -67,7 +66,6 @@ void shouldBeAbleToExecuteLs() {
   }
 
   @Test
-  @EnabledOnOs({OS.LINUX, OS.MAC, OS.WINDOWS})
   void shouldNotBeAbleToExecuteMissing() {
     // given
     final var tool = Paths.get("asdfasdfasadaggfksdjfgsdfglsdfglsfg");
@@ -92,20 +90,6 @@ void shouldNotBeAbleToExecuteTextFile() {
     assertFalse(canExecute);
   }
 
-  @Test
-  @EnabledOnOs(OS.WINDOWS)
-  @DisplayName("Should detect tool in PATH (Windows)")
-  void shouldDetectToolInPathWindows() {
-    // given
-    final var tool = "cmd";
-
-    // when
-    final var path = Executables.of(tool);
-
-    // then
-    assertTrue(path.isPresent());
-  }
-
   @Test
   @EnabledOnOs({OS.LINUX, OS.MAC})
   @DisplayName("waits until tool exits")
@@ -149,21 +133,6 @@ void shouldWriteDebugMessageToSystemOut() throws Exception {
     assertEquals("ilo executes: ls\n", text);
   }
 
-  @Test
-  @EnabledOnOs(OS.WINDOWS)
-  @DisplayName("writes debug message to system.out on Windows")
-  void shouldWriteDebugMessageToSystemOutWindows() throws Exception {
-    // given
-    final var tool = "cmd";
-
-    // when
-    final var text = SystemLambda.tapSystemOutNormalized(
-      () -> Executables.runAndWaitForExit(List.of(tool), true));
-
-    // then
-    assertEquals("ilo executes: cmd\n", text);
-  }
-
   @Test
   @DisplayName("ignores empty lists")
   void shouldNoExecuteEmptyList() {