Merge pull request #19 from OpenVoxProject/windows

Changes for OpenVox Windows builds

Author: nmburgan

.gitignore

@@ -15,3 +15,4 @@ acceptance/merged_options.rb
 acceptance/.beaker/*
 ext/smoke/*output.txt
 *~
+**/.DS_Store

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Unreleased
 
+* Added Windows x64 support. This should work on Windows Server 2016+ and Windows 10+.
+* Updated Boost to 1.82.0 for Windows only in order to fix a bug needed for buidling the Windows agent. https://github.com/boostorg/locale/commit/41868c62a0519799696b544518f1efd831ff71c2
 * Fixed issue on Fedora 41 with dnf5. We were using deprecated yum flags -d and -e. Since we don't support anything older than EL7, in which these were already deprecated, they have been removed.
 
 ## 8.13.0

Rakefile

@@ -1,6 +1,15 @@
-def run_command(cmd)
-  output, status = Open3.capture2e(cmd)
-  abort "Command failed! Command: #{cmd}, Output: #{output}" unless status.exitstatus.zero?
+require 'open3'
+
+def run_command(cmd, silent = false)
+  output = ''
+  Open3.popen2e(cmd) do |_stdin, stdout_stderr, thread|
+    stdout_stderr.each do |line|
+      puts line unless silent
+      output += line
+    end
+    exitcode = thread.value.exitstatus
+    abort "Command failed!" unless exitcode.zero?
+  end
   output.chomp
 end
 

configs/components/puppet-runtime.json

@@ -1 +1 @@
-{"location":"https://s3.osuosl.org/openvox-artifacts/puppet-runtime/202502261/","version":"202502261"}
+{"location":"https://s3.osuosl.org/openvox-artifacts/puppet-runtime/202503201/","version":"202503201"}

configs/components/puppet-runtime.rb

@@ -31,9 +31,10 @@
     # Elevate.exe is simply used when one of the run_facter.bat or
     # run_puppet.bat files are called. These set up the required environment
     # for the program, and elevate.exe gives the program the elevated
-    # privileges it needs to run
+    # privileges it needs to run.
+    # Comes from https://github.com/jpassing/elevate
     pkg.add_source "file://resources/files/windows/elevate.exe.config", sum: "a5aecf3f7335fa1250a0f691d754d561"
-    pkg.add_source "#{settings[:buildsources_url]}/windows/elevate/elevate.exe", sum: "bd81807a5c13da32dd2a7157f66fa55d"
+    pkg.add_source "https://artifacts.overlookinfratech.com/components/elevate.exe", sum: "bd81807a5c13da32dd2a7157f66fa55d"
     pkg.install_file 'elevate.exe.config', "#{settings[:bindir]}/elevate.exe.config"
     pkg.install_file 'elevate.exe', "#{settings[:bindir]}/elevate.exe"
 

configs/components/puppet.rb

@@ -6,15 +6,8 @@
 
   # Used to compile binary translation files
   # i18n is not supported on Solaris
-  if platform.is_macos?
-    pkg.build_requires "gettext"
-  elsif platform.is_windows?
-    pkg.build_requires "pl-gettext-#{platform.architecture}"
-  elsif platform.is_solaris? || platform.is_aix?
-    # do nothing
-  else #rubocop:disable Lint/DuplicateBranch
-    pkg.build_requires "gettext"
-  end
+  pkg.build_requires "gettext" unless platform.is_solaris? || platform.is_aix?
+  pkg.build_requires "gettext-devel" if platform.is_windows?
 
   platform.get_service_types.each do |servicetype|
     case servicetype
@@ -90,7 +83,7 @@
   # We do not currently support i18n on Solaris or AIX
   unless platform.is_solaris? || platform.is_aix?
     if platform.is_windows?
-      msgfmt = "/cygdrive/c/tools/pl-build-tools/bin/msgfmt.exe"
+      msgfmt = "/usr/bin/msgfmt.exe"
     elsif platform.is_macos?
       msgfmt = "/usr/local/opt/gettext/bin/msgfmt"
       if platform.architecture == 'arm64' && platform.os_version.to_i >= 13
@@ -121,7 +114,7 @@
   end
 
   if platform.is_windows?
-    pkg.environment "PATH", "$(shell cygpath -u #{settings[:gcc_bindir]}):$(shell cygpath -u #{settings[:ruby_bindir]}):$(shell cygpath -u #{settings[:bindir]}):/cygdrive/c/Windows/system32:/cygdrive/c/Windows:/cygdrive/c/Windows/System32/WindowsPowerShell/v1.0"
+    pkg.environment "PATH", "/usr/bin:$(shell cygpath -u #{settings[:gcc_bindir]}):$(shell cygpath -u #{settings[:ruby_bindir]}):$(shell cygpath -u #{settings[:bindir]}):/cygdrive/c/Windows/system32:/cygdrive/c/Windows:/cygdrive/c/Windows/System32/WindowsPowerShell/v1.0"
   end
 
   if platform.is_windows?
@@ -201,7 +194,7 @@
 
     pkg.install_file "ext/windows/service/daemon.bat", "#{settings[:bindir]}/daemon.bat"
     pkg.install_file "ext/windows/service/daemon.rb", "#{settings[:service_dir]}/daemon.rb"
-    pkg.install_file "../wix/icon/puppet.ico", "#{settings[:miscdir]}/puppet.ico"
+    pkg.install_file "../wix/icon/voxpupuli.ico", "#{settings[:miscdir]}/voxpupuli.ico"
     pkg.install_file "../wix/license/LICENSE.rtf", "#{settings[:miscdir]}/LICENSE.rtf"
     pkg.directory settings[:service_dir]
   end

configs/platforms/windows-2019-x64.rb

@@ -0,0 +1,49 @@
+platform "windows-2019-x64" do |plat|
+  plat.vmpooler_template "win-2019-x86_64"
+  plat.servicetype 'windows'
+
+  # You must install Wix Toolset 3.14.1 manually before beginning the build.
+  # https://github.com/wixtoolset/wix3/releases/download/wix3141rtm/wix314.exe
+  #
+  # Install ruby, ruby-devel, gcc-core, make, git, and libyaml-devel in Cygwin on the Windows image.
+  # Run setup.bat found in the root of this repo. These are needed in order to successfully
+  # do a bundle install. They are included here just in case they get removed somehow.
+  # Make sure "setup-x86_64.exe" (Cygwin's installer) is at the root of C:/
+  packages = [
+    'autoconf',
+    'cmake',
+    'gcc-core',
+    'gcc-g++',
+    'gettext',
+    'gettext-devel',
+    'git',
+    'libyaml-devel',
+    'make',
+    'mingw64-x86_64-gcc-core',
+    'mingw64-x86_64-gcc-g++',
+    'mingw64-x86_64-gdbm',
+    'mingw64-x86_64-libffi',
+    'mingw64-x86_64-readline',
+    'mingw64-x86_64-zlib',
+    'ruby',
+    'ruby-devel',
+    'patch',
+  ]
+
+  plat.provision_with("C:/setup-x86_64.exe -q -P #{packages.join(',')}")
+  plat.install_build_dependencies_with "C:/setup-x86_64.exe -q -P"
+
+  plat.make "/usr/bin/make"
+  plat.patch "TMP=/var/tmp /usr/bin/patch.exe --binary"
+
+  plat.platform_triple "x86_64-w64-mingw32"
+
+  # Putting these here as a reminder where we use them elsewhere. DO NOT
+  # use the full path, just the name of the executable without the extension.
+  # Otherwise, autoconf gets confused.
+  plat.environment 'CC', "x86_64-w64-mingw32-gcc"
+  plat.environment 'CXX', "x86_64-w64-mingw32-g++"
+
+  plat.package_type "msi"
+  plat.output_dir "windows"
+end

configs/projects/openvox-agent.rb

@@ -112,7 +112,18 @@
   # Provides augeas, curl, libedit, libxml2, libxslt, openssl, puppet-ca-bundle, ruby and rubygem-*
   proj.component "puppet-runtime"
   proj.component 'openssl-fips' if platform.is_fips?
-  proj.component "pxp-agent" if ENV['NO_PXP_AGENT'].to_s.empty?
+
+  # We are currently not building pxp-agent for Windows because it is unused for
+  # OpenVox aside from execution_wrapper which is soon to be replaced, and because
+  # we're having trouble getting things compiled correctly with the modern toolchain.
+  # For a Windows, only build these if BUILD_WINDOWS_PXP_AGENT is set.
+  # For other platforms, build these unless NO_PXP_AGENT is set.
+  build_pxp_agent = platform.is_windows? ? !ENV['BUILD_WINDOWS_PXP_AGENT'].to_s.empty? : ENV['NO_PXP_AGENT'].to_s.empty?
+  if build_pxp_agent
+    proj.component "pxp-agent"
+  else
+    proj.setting(:exclude_wix_templates, ['service.pxp-agent.wxs.erb'])
+  end
 
   proj.component "puppet"
   proj.component "facter"

resources/windows/wix/appdatafiles.wxs

@@ -1,9 +1,9 @@
 <?xml version='1.0' encoding='windows-1252'?>
 <Wix xmlns='http://schemas.microsoft.com/wix/2006/wi' xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
   <!--
-    Puppet Agent Specific Application data
+    OpenVox Agent Specific Application data
     These directories and files need to be special cased
-    in order to manage the application data for puppet
+    in order to manage the application data for the OpenVox
     agent. The specific special case is that all files
     and folders here need to be persistent across multiple
     installs and uninstalls. We can do so by specifying
@@ -13,7 +13,7 @@
 
     <DirectoryRef Id="TARGETDIR">
       <Directory Id="CommonAppDataFolder" Name="CommonAppData">
-        <Directory Id="APPDATADIR" Name="PuppetLabs">
+        <Directory Id="APPDATADIR" Name="VoxPupuli">
           <Directory Id="pxpAgentDataFolder" Name="pxp-agent">
             <Directory Id="pxpAgentDataFolderVar" Name="var">
               <Directory Id="pxpAgentDataFolderLog" Name="log" />
@@ -47,7 +47,7 @@
     </DirectoryRef>
     <ComponentGroup Id="AppDataComponentGroup" >
       <Component
-        Id="PuppetLabsDataDir"
+        Id="VoxPupuliDataDir"
         Guid="EA55AEDB-3A9E-454E-9389-828341BEB4FC"
         Permanent="yes"
         Directory="APPDATADIR" >
@@ -250,7 +250,7 @@
         <File
           Id="HieraConf"
           KeyPath="yes"
-          Source="SourceDir\CommonAppDataFolder\Puppetlabs\puppet\etc\hiera.yaml" />
+          Source="SourceDir\CommonAppDataFolder\VoxPupuli\puppet\etc\hiera.yaml" />
         <Condition>NOT PUP_PREEXISTING_CODE_HIERA AND NOT PUP_PREEXISTING_CONF_HIERA</Condition>
       </Component>
       <Component
@@ -263,7 +263,7 @@
         <File
           Id="HieraProductionConf"
           KeyPath="yes"
-          Source="SourceDir\CommonAppDataFolder\Puppetlabs\code\environments\production\hiera.yaml" />
+          Source="SourceDir\CommonAppDataFolder\VoxPupuli\code\environments\production\hiera.yaml" />
         <Condition>NOT PUP_PREEXISTING_CODE_HIERA AND NOT PUP_PREEXISTING_CONF_HIERA</Condition>
       </Component>
       <Component
@@ -339,7 +339,7 @@
         <File
           Id="EnvironmentConf"
           KeyPath="yes"
-          Source="SourceDir\CommonAppDataFolder\PuppetLabs\code\environments\production\environment.conf" />
+          Source="SourceDir\CommonAppDataFolder\VoxPupuli\code\environments\production\environment.conf" />
       </Component>
       <Component
         Id="ManifestsDir"

resources/windows/wix/componentgroup.wxs.erb

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="windows-1252"?>
 <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi" xmlns:util="http://schemas.microsoft.com/wix/UtilExtension">
 
-  <!-- Puppet Agent Specific Component Group File -->
+  <!-- OpenVox Agent Specific Component Group File -->
 
   <Fragment>
     <ComponentGroup Id="MainComponentGroup">