Merge pull request #334 from ianfixes/2021-02-15_rescue

Work in progress: 2022 Mergefest

Author: ianfixes

.gitattributes

@@ -13,7 +13,7 @@
 # the Git repository itself.
 
 # Set the default behavior, in case people don't have core.autocrlf set.
-* text=auto
+* text=auto eol=lf
 
 # Explicitly declare text files you want to always be normalized and converted
 # to native line endings on checkout. Git would likely get these right, but

.github/workflows/linux.yaml

@@ -11,25 +11,25 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Check style, functionality, and usage
+      - name: Check style
         run: |
           g++ -v
           bundle install
           bundle exec rubocop --version
           bundle exec rubocop -D .
 
-  "rspec":
+  "rspec-linux":
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Check style, functionality, and usage
+      - name: Check functionality
         run: |
           g++ -v
           bundle install
-          bundle exec rspec --backtrace
+          bundle exec rspec
 
   "TestSomething":
     runs-on: ubuntu-latest
@@ -38,7 +38,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: TestSomething
+      - name: Check usage - TestSomething
         run: |
           g++ -v
           bundle install
@@ -53,7 +53,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Test NetworkLib from scratch
+      - name: Check usage - Test NetworkLib from scratch
         run: |
           g++ -v
           cd SampleProjects/NetworkLib
@@ -69,5 +69,5 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Test SharedLibrary should fail
+      - name: Check usage - Test SharedLibrary should fail
         run: ./SampleProjects/SharedLibrary/test.sh

.github/workflows/macos.yaml

@@ -11,25 +11,25 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Check style, functionality, and usage
+      - name: Check style
         run: |
           g++ -v
           bundle install
           bundle exec rubocop --version
           bundle exec rubocop -D .
 
-  "rspec":
+  "rspec-macos":
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Check style, functionality, and usage
+      - name: Check functionality
         run: |
           g++ -v
           bundle install
-          bundle exec rspec --backtrace
+          bundle exec rspec
 
   "TestSomething":
     runs-on: macos-latest
@@ -38,7 +38,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: TestSomething
+      - name: Check usage - TestSomething
         run: |
           g++ -v
           bundle install
@@ -53,7 +53,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Test NetworkLib from scratch
+      - name: Check usage - Test NetworkLib from scratch
         run: |
           g++ -v
           cd SampleProjects/NetworkLib
@@ -69,5 +69,5 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Test SharedLibrary should fail
+      - name: Check usage - Test SharedLibrary should fail
         run: ./SampleProjects/SharedLibrary/test.sh

.github/workflows/spelling.yaml

@@ -21,6 +21,6 @@ jobs:
           fetch-depth: 0
 
       - name: Check Spelling
-        uses: codespell-project/actions-codespell@master
+        uses: codespell-project/actions-codespell@v1.0
         with:
           check_filenames: true

.github/workflows/windows.yaml

@@ -4,30 +4,41 @@ name: windows
 on: [push, pull_request]
 
 jobs:
-  "rubocop_and_rspec":
+  "rubocop":
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Check style, functionality, and usage
+      - name: Check style
         run: |
           g++ -v
           bundle install
           bundle exec rubocop --version
-          bundle exec rubocop -D .
-          echo "done with Rubocop (See https://github.com/Arduino-CI/arduino_ci/issues/315)"
-          bundle exec rspec --backtrace
+          bundle exec rubocop -D . --except Layout/EndOfLine
 
-  "TestSomething":
+  "rspec-windows":
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: TestSomething
+      - name: Check functionality
+        run: |
+          g++ -v
+          bundle install
+          bundle exec rspec
+
+  TestSomething:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Check usage - TestSomething
         run: |
           g++ -v
           bundle install
@@ -42,7 +53,7 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Test NetworkLib from scratch
+      - name: Check usage - Test NetworkLib from scratch
         run: |
           g++ -v
           cd SampleProjects/NetworkLib
@@ -58,5 +69,5 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
-      - name: Test SharedLibrary should fail
+      - name: Check usage - Test SharedLibrary should fail
         run: ./SampleProjects/SharedLibrary/test.sh

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Support for `dtostrf()`
 - Added a CI workflow to lint the code base
 - Added a CI workflow to check for spelling errors
+- Extraction of byes usage in a compiled sketch is now calculated in a method: `ArduinoBackend.last_bytes_usage`
+- Added ```nano_every``` platform to represent ```arduino:megaavr``` architecture
+- Working directory is now printed in test runner output
+- Explicitly include `irb` via rubygems
 
 ### Changed
 - We now compile a shared library to be used for each test.
@@ -22,6 +26,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Update .gitattributes so we have consistent line endings
 - Change 266 files from CRLF to LF.
 - Run tests on push as well as on a pull request so developers can see impact
+- `ArduinoBackend` now exposes `config_file_path` instead of `config_dir` so that we can be explicit about [strange behavior in `arduino-cli` that isn't going to change anytime soon](https://github.com/arduino/arduino-cli/issues/753)
+- Use `arduino-cli` version `0.29.0` as the backend
+- Test runner detects console width if possible, allowing variable width from 80-132 chars
 
 ### Deprecated
 
@@ -33,6 +40,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Apply "rule of three" to Client copy constructor and copy assignment operator
 - Run Windows tests on Windows not Ubuntu
 - Properly report error in building shared library
+- A missing `examples` directory no longer causes a crash in `cpp_library.rb`
+- Referring to an undefined platform no longer causes a crash; it's now a helpful error message
+- A copy/paste error that prevented compiler warning flags from being supplied has been fixed, via jgfoster
+- RSpec was not communicating compile errors from unit test executables that failed to build. Now it does, via jgfoster
+- Windows paths now avoid picking up backslashes, for proper equality comparisons
+- Libraries are now considered installed if their entry is a symlink (for which `exist?` would return `false`)
 
 ### Security
 

CONTRIBUTING.md

@@ -9,7 +9,7 @@ ArduinoCI uses a very standard GitHub workflow.
     * If you are submitting code, use `master` as the base branch
     * If you are submitting broken unit tests (illustrating a bug that should be fixed), use `tdd` as the base branch.
 
-Pull requests will trigger a Travis CI job.  The following two commands will be expected to pass (so you may want to run them locally before opening the pull request):
+Pull requests will trigger a CI job.  The following two commands will be expected to pass (so you may want to run them locally before opening the pull request):
 
 * `bundle exec rubocop -D .` - code style tests
 * `bundle exec rspec` - functional tests

Gemfile

@@ -6,6 +6,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem "bundler", "> 1.15", require: false, group: :test
+gem "irb", "~> 1.3.5", require: false
 gem "keepachangelog_manager", "~> 0.0.2", require: false, group: :test
 gem "rspec", "~> 3.0", require: false, group: :test
 gem 'rubocop', '~>1.5.0', require: false, group: :test

README.md

@@ -5,13 +5,12 @@
 [![Gitter](https://badges.gitter.im/Arduino-CI/arduino_ci.svg)](https://gitter.im/Arduino-CI/arduino_ci?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![GitHub Marketplace](https://img.shields.io/badge/Get_it-on_Marketplace-informational.svg)](https://github.com/marketplace/actions/arduino_ci)
 
-Arduino CI was created to enable better collaboration among Arduino library maintainers and contributors, by enabling automated code checks to be performed as part of a pull request process.
+Arduino CI tests [Arduino libraries](https://arduino.github.io/arduino-cli/library-specification/); it was created to enable better collaboration among Arduino library maintainers and contributors, by enabling automated code checks to be performed as part of a pull request process.
 
 * enables running unit tests against the library **without hardware present**
 * provides a system of mocks that allow fine-grained control over the hardware inputs, including the system's clock
 * verifies compilation of any example sketches included in the library
 * can test a wide range of arduino boards with different hardware options available
-* compares entries in `library.properties` to the contents of the library and reports mismatches
 * can be run both locally and as part of CI (GitHub Actions, TravisCI, Appveyor, etc.)
 * runs on multiple platforms -- any platform that supports the Arduino IDE
 * provides detailed analysis of segfaults in compilers that support such debugging features

SampleProjects/TestSomething/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
 gem 'arduino_ci', path: '../../'
+gem "irb", "~> 1.3.5", require: false