Adding option to install omc-diff on Linux (#273)

Author: AnHeuermann

.github/workflows/test.yml

@@ -35,4 +35,5 @@ jobs:
           libraries: |
             'Modelica 4.0.0'
             'Modelica 3.2.3+maint.om'
+          omc-diff: true
       - run: echo $OPENMODELICAHOME

LICENSE

@@ -1,4 +1,3 @@
-
 The MIT License (MIT)
 
 Copyright (c) 2018 GitHub, Inc. and contributors
@@ -20,4 +19,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

README.md

@@ -81,6 +81,7 @@ On Linux apt is used to install OpenModelica, on Windows the installer executabl
     libraries: |
       'Modelica 4.0.0'
       'Modelica 3.2.3+maint.om'
+    omc-diff: true
 ```
 
 ```yaml
@@ -117,6 +118,14 @@ $ npm run package
 $ npm test
 ```
 
+## License
+
+This action is licensed under the MIT license, see [LICENSE.md](./LICENSE.md).
+OpenModelica and all OpenModelica tools are licensed under
+[GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
+or the 
+[OSMC (Open Source Modelica Consortium) Public License (OSMC-PL) version 1.8](https://openmodelica.org/osmc-pl/osmc-pl-1.8.txt).
+
 ## Acknowledgments
 
 This package was developed as part of the [Proper Hybrid Models for Smarter Vehicles (PHyMoS)](https://phymos.de/en/) project,

__tests__/installer.test.ts

@@ -136,6 +136,16 @@ function linuxTests(): void {
     },
     10 * 60000
   )
+
+  test(
+    'Install omc-diff',
+    async () => {
+      await installer.installOmcDiff(true)
+      const fileExists = fs.existsSync('/usr/bin/omc-diff')
+      expect(fileExists).toBe(true)
+    },
+    10 * 60000
+  )
 }
 
 function windowsTests(): void {

action.yml

@@ -23,6 +23,10 @@ inputs:
                   One library per line, separate version number with a space <library> <version>
                   Example: "Modelica 4.0.0"'
     required: false
+  omc-diff:
+    description: 'Install OpenModelica omc-diff tool.'
+    required: false
+    default: false
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "setup-openmodelica",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "engines": {
     "node": ">=18.0.0"
   },

dist/index.js.map

@@ -1,14 +1,13 @@
 import * as core from '@actions/core'
 import * as exec from '@actions/exec'
 
+import {cwd} from 'process'
 import * as fs from 'fs'
 import * as os from 'os'
 import * as path from 'path'
-import {cwd} from 'process'
 import * as semver from 'semver'
-
-import json from './versions.json'
 import * as util from './util'
+import json from './versions.json'
 
 export type VersionType = {
   version: string
@@ -331,3 +330,40 @@ ${installPackages.join('\n')}`
 
   return filename
 }
+
+/**
+ * Install OpenModelica omc-diff program.
+ *
+ * @param useSudo       true if root rights are required.
+ */
+export async function installOmcDiff(useSudo: boolean): Promise<void> {
+
+  switch (osPlat) {
+    case 'linux':
+      break
+    case 'win32':
+      core.info(`Windows version of OpenModelica already installs omc-diff.`)
+      return
+    default:
+      throw new Error(
+        `omc-diff not available for platform ${osPlat}. Open a feature request on https://github.com/AnHeuermann/omc-diff.`
+      )
+  }
+
+  const sudo: string = useSudo ? 'sudo' : ''
+
+  // Download executable from https://github.com/AnHeuermann/omc-diff/
+  const url =
+    'https://github.com/AnHeuermann/omc-diff/releases/download/v0.1/linux-64.tar.gz'
+  const file = url.split('/').pop()
+  if (file === undefined) {
+    throw new Error(`Something wrong with the url`)
+  }
+  await exec.exec(`wget ${url}`)
+
+  // Extract .tar.gz
+  await exec.exec(`${sudo} tar -xvf ${file} -C /usr/bin/`)
+
+  // Clean up
+  fs.rmSync(file)
+}