libR-sys 0.2.1

Low level bindings to the R programming language.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

name: Tests

on:
  push:
    branches:
      - main
      - master
  pull_request:
    branches:
      - main
      - master

jobs:

  test_with_bindgen:
    runs-on: ${{ matrix.config.os }}

    name: ${{ matrix.config.os }} (R-${{ matrix.config.r }} rust-${{ matrix.config.rust-version }})
              
    strategy:
      fail-fast: false
      matrix:
        config:
          - {os: windows-latest, r: 'release', rust-version: 'stable-msvc',  targets: ['x86_64-pc-windows-gnu', 'i686-pc-windows-gnu']}
          - {os: windows-latest, r: 'release', rust-version: 'nightly-msvc', targets: ['x86_64-pc-windows-gnu', 'i686-pc-windows-gnu']}
          - {os: windows-latest, r: 'devel',   rust-version: 'stable-msvc',  targets: ['x86_64-pc-windows-gnu', 'i686-pc-windows-gnu']}
          - {os: windows-latest, r: 'oldrel',  rust-version: 'stable-msvc',  targets: ['x86_64-pc-windows-gnu', 'i686-pc-windows-gnu']}

          - {os: macOS-latest,   r: 'release', rust-version: 'stable'}
          - {os: macOS-latest,   r: 'release', rust-version: 'nightly'}
          - {os: macOS-latest,   r: 'devel',   rust-version: 'stable'}
          - {os: macOS-latest,   r: 'oldrel',  rust-version: 'stable'}
          - {os: macOS-11.0,     r: 'release', rust-version: 'nightly',      targets: ['default', 'aarch64-apple-darwin'], 
            no-test-targets: 'aarch64-apple-darwin', emit-bindings: 'true'}

          - {os: ubuntu-20.04,   r: 'release', rust-version: 'stable',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
          - {os: ubuntu-20.04,   r: 'release', rust-version: 'nightly', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
          # R-devel requires LD_LIBRARY_PATH
          - {os: ubuntu-20.04,   r: 'devel',   rust-version: 'stable',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}   
          - {os: ubuntu-20.04,   r: 'oldrel',  rust-version: 'stable',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}   



    env:
      RSPM: ${{ matrix.config.rspm }}

    # PowerShell core is available on all platforms and can be used to unify scripts
    defaults:
      run:
        shell: pwsh
      
    steps:
      
      - uses: actions/checkout@v2
      
      - name: Set up R
        uses: r-lib/actions/setup-r@v1
        with:
          r-version: ${{ matrix.config.r }}

      - name: Set up Rust
        uses: actions-rs/toolchain@v1
        with:
          toolchain: ${{ matrix.config.rust-version }}
          default: true
          components: rustfmt, clippy

      - name: Configure targets
        run: |
          if ($env:RUST_TARGETS -eq '') {
            $env:RUST_TARGETS = "default"
          }
          foreach ($target in ($env:RUST_TARGETS).Split(",")) {
            if ($target -ne "default") {
              rustup target add $target
            }
          }
          echo "RUST_TARGETS=$env:RUST_TARGETS"  | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
        env:
          RUST_TARGETS: ${{ join(matrix.config.targets, ',')}}
      
      # All configurations for Windows go here
      # Rust toolchain is used to determine target architecture
      - name: Configure Windows
        if: runner.os == 'Windows'
        # 1. Configure path to libclang
        # 2. Add path to mingw32/mingw64 -- otherwise library is linked to rtools
        # 3. Add path to R's i386/x64  -- to solve x86 build/test issue
        run: |
          if ($env:RUST_TARGETS -like "*x86_64*") {
            echo "C:\msys64\mingw64\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append ;
            echo "$(Rscript.exe -e 'cat(normalizePath(R.home()))')\bin\x64"  | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append ;
          }
          if ($env:RUST_TARGETS -like "*i686*") {
            echo "C:\msys64\mingw32\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append ;
            echo "$(Rscript.exe -e 'cat(normalizePath(R.home()))')\bin\i386"  | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append ;
          }
          

      # MacOS configurations, mainly llvm and path to libclang
      # Because of this R installation issue on MacOS-11.0 
      # https://github.com/r-lib/actions/issues/200
      # Symlinks to R/Rscript are not properly set up, so we do it by hand, using this trick
      # https://github.com/r-lib/ps/commit/a24f2c4d1bdba63be14e7729b9ab81d0ed9f719e
      # Environment variables are required fir Mac-OS-11.0, see
      # https://github.com/extendr/libR-sys/issues/35
      - name: Configure MacOs
        if: runner.os == 'macOS'
        run: | 
          brew install llvm
          echo "LIBCLANG_PATH=$(brew --prefix llvm)/lib" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
          $env:LLVM_CONFIG_PATH = "$(brew --prefix llvm)/bin/llvm-config" 
          echo "LLVM_CONFIG_PATH=$env:LLVM_CONFIG_PATH" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
          echo "LIBRSYS_LIBCLANG_INCLUDE_PATH=$(. $env:LLVM_CONFIG_PATH --libdir)/clang/$(. $env:LLVM_CONFIG_PATH --version)/include"  | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append

          if ((Get-ChildItem -Path /usr/local/bin -Filter R | Measure-Object).Count -eq 0) {
            echo "::warning:: Found no R symlink in /usr/local/bin, setting up manually..."
            ln -s /Library/Frameworks/R.framework/Versions/Current/Resources/bin/R /usr/local/bin/
          }
          if ((Get-ChildItem -Path /usr/local/bin -Filter Rscript | Measure-Object).Count -eq 0) {
            echo "::warning:: Found no Rscript symlink in /usr/local/bin, setting up manually..."
            ln -s /Library/Frameworks/R.framework/Versions/Current/Resources/bin/Rscript /usr/local/bin/
          }

      # This is required for ubuntu r-devel
      # 'Del alias:R' removes R alias which prevents running R 
      - name: Configure Linux
        if: runner.os == 'linux'
        run: |
          Del alias:R
          echo "LD_LIBRARY_PATH=$(R -s -e 'cat(normalizePath(R.home()))')/lib" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append

      # Build and emit bindings to './generated_bindings'
      - name: Build & Emit bindings
        id: build
        run: |
          foreach ($target in ($env:RUST_TARGETS).Split(",")) {
            echo "Building for target: $target"
            cargo build -vv --features use-bindgen $(if ($target -ne 'default') {"--target=$target"} )
            if (!$?) { 
              echo "::error::$target" ;
              throw "Last exit code $LASTEXITCODE"
            }
          }
        env:
          LIBRSYS_BINDINGS_OUTPUT_PATH: generated_bindings

      # Test the result of previous step
      - name: Run tests
        id: test
        run: |
          foreach ($target in ($env:RUST_TARGETS).Split(",")) {
            if(($env:NO_TEST_TARGETS).Split(",").Contains($target)) {
              echo "::warning:: Skipping bindgen tests for target: $target"
            }
            else {
              echo "Running bindgen tests for target: $target"
              cargo test -vv --features use-bindgen $(if ($target -ne 'default') {"--target=$target"} ) -- --nocapture --test-threads=1
              if (!$?) { 
                echo "::error::$target";
                throw "Last exit code $LASTEXITCODE"
              }
            }
          }
        env: 
          NO_TEST_TARGETS: ${{ join(matrix.config.no-test-targets, ',') }}
            


      # If success
      # AND (either rust is stable and 'emit-bindings' != 'false'
      #      OR rust is any and 'emit-bindings' == 'true'),
      # upload bindings
      - name: Upload generated bindings
        if: 
          steps.build.outcome == 'success' && 
          steps.test.outcome == 'success' && 
          ((startsWith(matrix.config.rust-version, 'stable') && matrix.config.emit-bindings != 'false') ||
            (matrix.config.emit-bindings == 'true'))
        uses: actions/upload-artifact@main
        with:
          name: ${{ matrix.config.os }} (R-${{ matrix.config.r }} rust-${{ matrix.config.rust-version }}) generated bindings
          path: generated_bindings

      # Run tests again using different bindings
      - name: Run tests on precomputed bindings shipped with libR-sys
        run: |
          foreach ($target in ($env:RUST_TARGETS).Split(",")) {
            if(($env:NO_TEST_TARGETS).Split(",").Contains($target)) {
              echo "::warning:: Skipping tests for target: $target"
            }
            else {            
              echo "Running tests for target: $target"
              cargo test -vv $(if ($target -ne 'default') {"--target=$target"} ) -- --nocapture --test-threads=1
              if (!$?) { 
                echo "::error::$target";
                throw "Last exit code $LASTEXITCODE"
              }
            }
          }
        env: 
          NO_TEST_TARGETS: ${{ join(matrix.config.no-test-targets, ',') }}