neyuki 0.6.0

A small Lua-like scripting language implemented in Rust
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

name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

permissions:
  contents: read

env:
  CARGO_TERM_COLOR: always

jobs:
  fmt:
    name: Format check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - name: Check formatting
        run: cargo fmt --all -- --check

  clippy:
    name: Clippy lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy
      - name: Install webview system libraries
        if: runner.os == 'Linux'
        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends libwebkit2gtk-4.1-dev libgtk-3-dev libsoup-3.0-dev
      - name: Cache cargo
        uses: Swatinem/rust-cache@v2
      - name: Run clippy
        run: cargo clippy --all-targets --all-features -- -D warnings

  build:
    name: Build & test
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - name: Install webview system libraries
        if: runner.os == 'Linux'
        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends libwebkit2gtk-4.1-dev libgtk-3-dev libsoup-3.0-dev
      - name: Cache cargo
        uses: Swatinem/rust-cache@v2
      - name: Build
        run: cargo build --verbose
      - name: Run tests
        run: cargo test --verbose

  fuzz:
    name: Fuzz (time-boxed)
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - name: Cache cargo
        uses: Swatinem/rust-cache@v2
      # A debug build keeps overflow checks and debug assertions on, so
      # arithmetic bugs surface as panics. The fuzz sandbox cannot reach
      # `@neyuki/webview`, so it is left out along with the WebKitGTK
      # packages it would need.
      - name: Build
        run: cargo build --no-default-features
      # About 4.5 minutes in all. The bytecode loader and verifier go first
      # and get the most time: they read untrusted .nykb files. Any panic,
      # even one the VM would catch, or a case hanging for 20s fails the job.
      # The seed is printed; a crashing input is saved to fuzz-artifacts/.
      # Address space is capped so a runaway allocation aborts the run, with
      # the input that caused it left in fuzz-artifacts/<target>-current.*.
      - name: Fuzz
        run: |

          ulimit -v 6000000
          seed=$(( GITHUB_RUN_ID % 1000000007 ))
          ./target/debug/neyuki fuzz file --seconds 90 --seed "$seed" --keep-going
          ./target/debug/neyuki fuzz tree --seconds 60 --seed "$seed" --keep-going
          ./target/debug/neyuki fuzz vm --seconds 60 --seed "$seed" --keep-going
          ./target/debug/neyuki fuzz libs --seconds 45 --seed "$seed" --keep-going
          ./target/debug/neyuki fuzz memory --seconds 30 --seed "$seed" --keep-going
      - name: Upload crashing inputs
        if: failure()
        uses: actions/upload-artifact@v4
        with:
          name: fuzz-artifacts
          path: fuzz-artifacts/
          if-no-files-found: ignore

  deny:
    name: Dependency audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check advisories, licenses, bans and sources
        uses: EmbarkStudios/cargo-deny-action@v2
        with:
          command: check advisories licenses bans sources

  lint-libs:
    name: Lint bundled libraries
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - name: Install webview system libraries
        if: runner.os == 'Linux'
        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends libwebkit2gtk-4.1-dev libgtk-3-dev libsoup-3.0-dev
      - name: Cache cargo
        uses: Swatinem/rust-cache@v2
      - name: Build
        run: cargo build
      # Warnings fail the job too, not only errors.
      - name: Lint lib/*.nyk
        run: |

          status=0
          for file in lib/*.nyk; do
            if [ "$(./target/debug/neyuki lint --json "$file")" != "[]" ]; then
              ./target/debug/neyuki lint "$file" || true
              echo "::error file=$file::neyuki lint reported issues"
              status=1
            else
              echo "$file: clean"
            fi
          done
          exit $status