Allow control of --check-bounds command option (#46)

* allow control of bounds-check command option

* tryfix

* Update action.yml

Co-authored-by: Sascha Mann <git@mail.saschamann.eu>

* Update action.yml

Co-authored-by: Sascha Mann <git@mail.saschamann.eu>

* tryfix

* alternative bash if else approach

* another approach

* use julia_args approach

* add julia_args to kwargs func

* fix

* move julia_args to before return

* guard against v1.0

* add warning

* Update kwargs.jl

Co-authored-by: Sascha Mann <git@mail.saschamann.eu>

* handle the default state and improve error message

* Update kwargs.jl

Co-authored-by: Chris Foster <chris42f@gmail.com>

* Update kwargs.jl

Co-authored-by: Sascha Mann <git@mail.saschamann.eu>
Co-authored-by: Chris Foster <chris42f@gmail.com>

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @julia-actions/reviewers

.github/workflows/backup.yml

@@ -0,0 +1,33 @@
+name: Backup
+
+on:
+  schedule:
+    - cron: '5 4 * * 0'
+
+  workflow_dispatch:
+
+jobs:
+  backup:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Configure cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ${{ env.GITHUB_WORKSPACE }}
+            ~/.cache/restic
+          key: ${{ runner.os }}
+
+      - name: Install the correct Python version
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Run backup action
+        uses: julia-actions/restic-action@main
+        env: # Options: https://restic.readthedocs.io/en/latest/040_backup.html#environment-variables
+          RESTIC_REPOSITORY: b2:${{ secrets.B2_BUCKET }}:${{ github.repository }}
+          RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}
+          B2_ACCOUNT_ID: ${{ secrets.B2_ACCOUNT_ID }}
+          B2_ACCOUNT_KEY: ${{ secrets.B2_ACCOUNT_KEY }}

.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - "main"
+      - "master"
+    paths-ignore:
+      - "README.md"
+      - "LICENSE"
+  pull_request:
+    paths-ignore:
+      - "README.md"
+      - "LICENSE"
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "1.0"
+          - "1" # automatically expands to the latest stable 1.x release of Julia
+          - nightly
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+          - x86
+        # 32-bit Julia binaries are not available on macOS
+        exclude:
+          - os: macOS-latest
+            arch: x86
+
+    steps:
+      - name: Checkout Example.jl
+        uses: actions/checkout@v2
+        with:
+          repository: julia-actions/Example.jl
+
+      - name: Verify that test output file does not exist yet
+        run: test ! -f "$HOME/julia-runtest"
+        shell: bash
+
+      - name: Checkout julia-runtest
+        uses: actions/checkout@v2
+        with:
+          path: ./.github/actions/julia-runtest
+
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+
+      - uses: julia-actions/julia-buildpkg@v1
+
+      - uses: ./.github/actions/julia-runtest
+
+      - uses: julia-actions/julia-processcoverage@v1
+
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info
+
+      - name: Verify that test output file exists
+        run: test -f "$HOME/julia-runtest"
+        shell: bash

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2020 GitHub, Inc., David Anthoff and contributors
+Copyright (c) 2018-2021 GitHub, Inc., David Anthoff and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -8,7 +8,7 @@ Julia needs to be installed before this action can run. This can easily be achie
 
 And example workflow that uses this action might look like this:
 
-```
+```yaml
 name: Run tests
 
 on: [push, pull_request]
@@ -27,9 +27,45 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@latest
+      - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.julia-version }}
-      - uses: julia-actions/julia-buildpkg@latest
-      - uses: julia-actions/julia-runtest@latest
+          arch: ${{ matrix.julia-arch }}
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
 ```
+
+You can add this workflow to your repository by placing it in a file called `test.yml` in the folder `.github/workflows/`. [More info here](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions).
+
+### Prefixing the Julia command
+
+In some packages, you may want to prefix the `julia` command with another command, e.g. for running tests of certain graphical libraries with `xvfb-run`.
+In that case, you can add an input called `prefix` containing the command that will be inserted to your workflow:
+
+```yaml
+      - uses: julia-actions/julia-runtest@v1
+        with:
+          prefix: xvfb-run
+```
+
+If you only want to add this prefix on certain builds, you can [include additional values into a combination](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#example-including-additional-values-into-combinations) of your build matrix, e.g.:
+
+```yaml
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+        version: ['1.0', '1', 'nightly']
+        arch: [x64]
+        include:
+          - os: ubuntu-latest
+            prefix: xvfb-run
+    steps:
+    # ...
+      - uses: julia-actions/julia-runtest@v1
+        with:
+          prefix: ${{ matrix.prefix }}
+    # ...
+```
+
+This will add the prefix `xvfb-run` to all builds where the `os` is `ubuntu-latest`.

action.yml

@@ -7,8 +7,8 @@ branding:
   color: 'gray-dark'
 
 inputs:
-  inline:
-    description: 'Value passed to the --inline flag. Options: yes | no. Default value: yes.'
+  check_bounds:
+    description: 'Value determining which bounds checking setting to use. Options: yes | no | auto. Default value: yes.'
     default: 'yes'
   coverage:
     description: 'Value determining whether to test with coverage or not. Options: true | false. Default value: true.'
@@ -16,6 +16,19 @@ inputs:
   depwarn:
     description: 'Value passed to the --depwarn flag. Options: yes | no | error. Default value: yes.'
     default: 'yes'
+  force_latest_compatible_version:
+    description: 'If true, then, for each [compat] entry in the active project, only allow the latest compatible version. If the value is auto and the pull request has been opened by Dependabot or CompatHelper, then force_latest_compatible_version will be set to true, otherwise it will be set to false. Options: true | false | auto. Default value: auto.'
+    default: 'auto'
+  inline:
+    description: 'Value passed to the --inline flag. Options: yes | no. Default value: yes.'
+    default: 'yes'
+  prefix:
+    description: 'Value inserted in front of the julia command, e.g. for running xvfb-run julia [...]'
+    default: ''
+    required: false
+  project:
+    description: 'Value passed to the --project flag. The default value is the repository root: "@."'
+    default: '@.'
 
 runs:
   using: 'composite'
@@ -28,7 +41,7 @@ runs:
     # * https://github.com/JuliaLang/Pkg.jl/issues/2011
     # * https://github.com/JuliaRegistries/General/issues/16777
     # * https://github.com/JuliaPackaging/PkgServer.jl/issues/60
-    - run: julia --color=yes -e 'using Pkg; VERSION >= v"1.5-" && !isdir(joinpath(DEPOT_PATH[1], "registries", "General")) && Pkg.Registry.add("General")'
+    - run: julia --color=yes "$GITHUB_ACTION_PATH"/add_general_registry.jl
       shell: bash
       env:
         # We set `JULIA_PKG_SERVER` only for this step to enforce
@@ -36,5 +49,14 @@ runs:
         # the request metadata to pkg.julialang.org when installing
         # packages via `Pkg.test`.
         JULIA_PKG_SERVER: ""
-    - run: julia --color=yes --check-bounds=yes --inline=${{ inputs.inline }} --depwarn=${{ inputs.depwarn }} --project -e 'using Pkg; Pkg.test(coverage=${{ inputs.coverage }})'
+    - run: |
+        # The Julia command that will be executed
+        julia_cmd=( julia --color=yes --depwarn=${{ inputs.depwarn }} --inline=${{ inputs.inline }} --project=${{ inputs.project }} -e 'import Pkg;include(joinpath(ENV["GITHUB_ACTION_PATH"], "kwargs.jl"));kwargs = Kwargs.kwargs(;coverage = :(${{ inputs.coverage }}),force_latest_compatible_version = :(${{ inputs.force_latest_compatible_version }}), julia_args = ["--check-bounds=${{ inputs.check_bounds }}"]);Pkg.test(; kwargs...)' )
+
+        # Add the prefix in front of the command if there is one
+        prefix="${{ inputs.prefix }}"
+        [[ -n $prefix ]] && julia_cmd=( "$prefix" "${julia_cmd[@]}" )
+
+        # Run the Julia command
+        "${julia_cmd[@]}"
       shell: bash

add_general_registry.jl

@@ -0,0 +1,49 @@
+using Pkg
+
+function general_registry_location()
+    general_registry_dir = joinpath(DEPOT_PATH[1], "registries", "General")
+    registry_toml_file = joinpath(general_registry_dir, "Registry.toml")
+    return general_registry_dir, registry_toml_file
+end
+
+function general_registry_exists()
+    general_registry_dir, registry_toml_file = general_registry_location()
+    if !isdir(general_registry_dir)
+        return false
+    elseif !isfile(registry_toml_file)
+        return false
+    else
+        return true
+    end
+end
+
+function add_general_registry()
+    @info("Attempting to clone the General registry")
+    general_registry_dir, registry_toml_file = general_registry_location()
+    rm(general_registry_dir; force = true, recursive = true)
+    Pkg.Registry.add("General")
+    isfile(registry_toml_file) || throw(ErrorException("the Registry.toml file does not exist"))
+    return nothing
+end
+
+function main(; n = 10, max_delay = 120)
+    VERSION >= v"1.5-" || return
+
+    if general_registry_exists()
+        @info("The General registry already exists locally")
+        return
+    end
+
+    delays = ExponentialBackOff(; n = n, max_delay = max_delay)
+    try
+        retry(add_general_registry; delays = delays)()
+        @info("Successfully added the General registry")
+    catch ex
+        msg = "I was unable to add the General registry. However, the build will continue."
+        @error(msg, exception=(ex,catch_backtrace()))
+    end
+
+    return
+end
+
+main()

autodetect-dependabot.jl

@@ -0,0 +1,25 @@
+module AutodetectDependabot
+
+function _get_possible_branch_names()
+    possible_branch_names = [
+        get(ENV, "GITHUB_BASE_REF", ""),
+        get(ENV, "GITHUB_HEAD_REF", ""),
+        get(ENV, "GITHUB_REF", ""),
+    ]
+    return possible_branch_names
+end
+
+function _chop_refs_head(branch_name::AbstractString)
+    replace(branch_name, r"^(refs\/heads\/)" => "")
+end
+
+function _is_dependabot_branch(branch_name::AbstractString)
+    return startswith(branch_name, "dependabot/julia") || startswith(branch_name, "compathelper/")
+end
+
+function is_dependabot_job()
+    possible_branch_names = _get_possible_branch_names()
+    return any(_is_dependabot_branch.(_chop_refs_head.(possible_branch_names)))
+end
+
+end # module

kwargs.jl

@@ -0,0 +1,41 @@
+module Kwargs
+
+import Pkg
+
+include(joinpath(@__DIR__, "autodetect-dependabot.jl"))
+
+function kwargs(; coverage::Bool,
+                  force_latest_compatible_version::Union{Bool, Symbol},
+                  julia_args::AbstractVector{<:AbstractString}=String[])
+    if !(force_latest_compatible_version isa Bool) && (force_latest_compatible_version != :auto)
+        throw(ArgumentError("Invalid value for force_latest_compatible_version: $(force_latest_compatible_version)"))
+    end
+
+    kwargs_dict = Dict{Symbol, Any}()
+    kwargs_dict[:coverage] = coverage
+
+    if VERSION >= v"1.6.0"
+        kwargs_dict[:julia_args] = julia_args
+    elseif julia_args == ["--check-bounds=yes"]
+        # silently don't add this default julia_args value as < 1.6 doesn't support julia_args, but it's the default state
+    else
+        println("::warning::The Pkg.test bounds checking behavior cannot be changed before Julia 1.6. VERSION=$VERSION, julia_args=$julia_args")
+    end
+
+    if VERSION < v"1.7.0-" || !hasmethod(Pkg.Operations.test, Tuple{Pkg.Types.Context, Vector{Pkg.Types.PackageSpec}}, (:force_latest_compatible_version,))
+        (force_latest_compatible_version != :auto) && @warn("The `force_latest_compatible_version` option requires at least Julia 1.7", VERSION, force_latest_compatible_version)
+        return kwargs_dict
+    end
+
+    if force_latest_compatible_version == :auto
+        is_dependabot_job = AutodetectDependabot.is_dependabot_job()
+        is_dependabot_job && @info("This is a Dependabot/CompatHelper job, so `force_latest_compatible_version` has been set to `true`")
+        kwargs_dict[:force_latest_compatible_version] = is_dependabot_job
+    else
+        kwargs_dict[:force_latest_compatible_version] = force_latest_compatible_version::Bool
+    end
+
+    return kwargs_dict
+end
+
+end # module