Merge branch 'cptr450' into digitalPinToPort

Author: James Foster

.github/workflows/Arduino-CI.yaml

@@ -0,0 +1,29 @@
+# This is the name of the workflow, visible on GitHub UI
+name: Arduino CI
+
+# Run on a Push or a Pull Request
+on: [push, pull_request]
+
+jobs:
+  runTest: 
+    runs-on: ubuntu-latest
+    steps:
+      # Clone the repo using the `checkout` action
+      - uses: actions/checkout@v2
+
+      # Get Ruby
+      - uses: ruby/setup-ruby@v1
+        with: 
+          ruby-version: 2.6
+
+      # Install and run Arduino CI tests
+      - name: Build and Execute
+        run: |
+          g++ -v
+          bundle install
+          bundle exec rubocop --version
+          bundle exec rubocop -D .
+          bundle exec rspec --backtrace
+          cd SampleProjects/TestSomething
+          bundle install
+          bundle exec arduino_ci_remote.rb

.travis.yml

@@ -26,4 +26,4 @@ script:
    - bundle exec rspec --backtrace
    - cd SampleProjects/TestSomething
    - bundle install
-   - bundle exec arduino_ci_remote.rb
+   - bundle exec arduino_ci.rb

CHANGELOG.md

@@ -9,11 +9,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Add `__AVR__` to defines when compiling
 - Add support for `diditalPinToPort()`, `digitalPinToBitMask()`, and `portOutputRegister()`
+- Support for mock EEPROM (but only if board supports it)
 
 ### Changed
 - Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci
+- Revise math macros to avoid name clashes
 
 ### Deprecated
+- Deprecated `arduino_ci_remote.rb` in favor of `arduino_ci.rb`
 
 ### Removed
 

README.md

@@ -94,15 +94,15 @@ $ bundle install --path vendor/bundle   # adds packages to local library
 With that installed, just the following shell command each time you want the tests to execute:
 
 ```
-$ bundle exec arduino_ci_remote.rb
+$ bundle exec arduino_ci.rb
 ```
 
-`arduino_ci_remote.rb` is the main entry point for this library.  This command will iterate over all the library's `examples/` and attempt to compile them.  If you set up unit tests, it will run those as well.
+`arduino_ci.rb` is the main entry point for this library.  This command will iterate over all the library's `examples/` and attempt to compile them.  If you set up unit tests, it will run those as well.
 
 
 ### Reference
 
-For more information on the usage of `arduino_ci_remote.rb`, see [REFERENCE.md](REFERENCE.md).  It contains information such as:
+For more information on the usage of `arduino_ci.rb`, see [REFERENCE.md](REFERENCE.md).  It contains information such as:
 
 * How to configure build options (platforms to test, Arduino library dependencies to install) with an `.arduino-ci.yml` file
 * Where to put unit test files
@@ -121,7 +121,7 @@ The following prerequisites must be fulfilled:
 
 ### Testing with remote CI
 
-> **Note:** `arduino_ci_remote.rb` expects to be run from the root directory of your Arduino project library.
+> **Note:** `arduino_ci.rb` expects to be run from the root directory of your Arduino project library.
 
 
 #### Travis CI
@@ -135,7 +135,7 @@ sudo: false
 language: ruby
 script:
   - bundle install
-  - bundle exec arduino_ci_remote.rb
+  - bundle exec arduino_ci.rb
 ```
 
 
@@ -149,7 +149,7 @@ Next, you'll need this in `appveyor.yml` in your repo.
 build: off
 test_script:
   - bundle install
-  - bundle exec arduino_ci_remote.rb
+  - bundle exec arduino_ci.rb
 ```
 
 ## Known Problems

REFERENCE.md

@@ -1,6 +1,6 @@
 # Build / Test Behavior of Arduino CI
 
-All tests are run via the same command: `bundle exec arduino_ci_remote.rb`.
+All tests are run via the same command: `bundle exec arduino_ci.rb`.
 
 This script is responsible for detecting and runing all unit tests, on every combination of Arduino platform and C++ compiler.  This is followed by attempting to detect and build every example on every "default" Arduino platform.
 
@@ -11,7 +11,7 @@ These defaults are specified in [misc/default.yml](misc/default.yml).  You are f
 
 ## Directly Overriding Build Behavior (short term use)
 
-When testing locally, it's often advantageous to limit the number of tests that are performed to only those tests that relate to the work you're doing; you'll get a faster turnaround time in seeing the results.  For a full listing, see `bundle exec arduino_ci_remote.rb --help`.
+When testing locally, it's often advantageous to limit the number of tests that are performed to only those tests that relate to the work you're doing; you'll get a faster turnaround time in seeing the results.  For a full listing, see `bundle exec arduino_ci.rb --help`.
 
 
 ### `--skip-unittests` option
@@ -233,14 +233,14 @@ For most build environments, the only script that need be executed by the CI sys
 ```shell
 # simplest build script
 bundle install
-bundle exec arduino_ci_remote.rb
+bundle exec arduino_ci.rb
 ```
 
 However, more flexible usage is available:
 
 ### Custom Versions of external Arduino Libraries
 
-Sometimes you need a fork of an Arduino library instead of the version that will be installed via their GUI.  `arduino_ci_remote.rb` won't overwrite existing downloaded libraries with fresh downloads, but it won't fetch the custom versions for you either.
+Sometimes you need a fork of an Arduino library instead of the version that will be installed via their GUI.  `arduino_ci.rb` won't overwrite existing downloaded libraries with fresh downloads, but it won't fetch the custom versions for you either.
 
 If this is the behavior you need, `ensure_arduino_installation.rb` is for you.  It ensures that an Arduino binary is available on the system.
 
@@ -261,7 +261,7 @@ git clone https://repository.com/custom_library_repo.git
 mv custom_library_repo $(bundle exec arduino_library_location.rb)
 
 # now run CI
-bundle exec arduino_ci_remote.rb
+bundle exec arduino_ci.rb
 ```
 
 Note the use of subshell to execute `bundle exec arduino_library_location.rb`.  This command simply returns the directory in which Arduino Libraries are (or should be) installed.
@@ -581,3 +581,40 @@ unittest(spi) {
   assertEqual("LMNOe", String(inBuf));
 }
 ```
+
+### EEPROM
+
+`EEPROM` is a global with a simple API to read and write bytes to persistent memory (like a tiny hard disk) given an `int` location. Since the Arduino core already provides this as a global, and the core API is sufficient for basic testing (read/write), there is no direct tie to the `GODMODE` API. (If you need more, such as a log of intermediate values, enter a feature request.)
+
+```C++
+unittest(eeprom)
+{
+  uint8_t a;
+  // size
+  assertEqual(EEPROM_SIZE, EEPROM.length());
+  // initial values
+  a = EEPROM.read(0);
+  assertEqual(255, a);
+  // write and read
+  EEPROM.write(0, 24);
+  a = EEPROM.read(0);
+  assertEqual(24, a);
+  // update
+  EEPROM.write(1, 14);
+  EEPROM.update(1, 22);
+  a = EEPROM.read(1);
+  assertEqual(22, a);
+  // put and get
+  const float f1 = 0.025f;
+  float f2 = 0.0f;
+  EEPROM.put(5, f1);
+  assertEqual(0.0f, f2);
+  EEPROM.get(5, f2);
+  assertEqual(0.025f, f2);
+  // array access
+  int val = 10;
+  EEPROM[2] = val;
+  a = EEPROM[2];
+  assertEqual(10, a);
+}
+```

SampleProjects/DoSomething/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 script:
    - bundle install
-   - bundle exec arduino_ci_remote.rb
+   - bundle exec arduino_ci.rb

SampleProjects/DoSomething/README.md

@@ -34,7 +34,7 @@ At a minimum, you will need the following lines in your file:
 language: ruby
 script:
    - bundle install
-   - bundle exec arduino_ci_remote.rb
+   - bundle exec arduino_ci.rb
 ```
 
 This will install the necessary ruby gem, and run it.  There are no command line arguments as of this writing, because all configuration is provided by...

SampleProjects/TestSomething/test/eeprom.cpp

@@ -0,0 +1,78 @@
+#include <ArduinoUnitTests.h>
+#include <Arduino.h>
+
+// Only run EEPROM tests if there is hardware support!
+#if defined(EEPROM_SIZE) || (defined(E2END) && E2END)
+#include <EEPROM.h>
+
+GodmodeState* state = GODMODE();
+unittest_setup()
+{
+  state->reset();
+}
+
+unittest(length)
+{
+  assertEqual(EEPROM_SIZE, EEPROM.length());
+}
+
+unittest(firstRead) 
+{
+  uint8_t a = EEPROM.read(0);
+  assertEqual(255, a);
+}
+
+unittest(writeRead)
+{
+  EEPROM.write(0, 24);
+  uint8_t a = EEPROM.read(0);
+  assertEqual(24, a);
+
+  EEPROM.write(0, 128);
+  a = EEPROM.read(0);
+  assertEqual(128, a);
+
+  EEPROM.write(0, 256);
+  a = EEPROM.read(0);
+  assertEqual(0, a);
+
+  int addr = EEPROM_SIZE / 2;
+  EEPROM.write(addr, 63);
+  a = EEPROM.read(addr);
+  assertEqual(63, a);
+
+  addr = EEPROM_SIZE - 1;
+  EEPROM.write(addr, 188);
+  a = EEPROM.read(addr);
+  assertEqual(188, a);
+}
+
+unittest(updateWrite)
+{
+  EEPROM.write(1, 14);
+  EEPROM.update(1, 22);
+  uint8_t a = EEPROM.read(1);
+  assertEqual(22, a);
+}
+
+unittest(putGet)
+{
+  const float f1 = 0.025f;
+  float f2 = 0.0f;
+  EEPROM.put(5, f1);
+  assertEqual(0.0f, f2);
+  EEPROM.get(5, f2);
+  assertEqual(0.025f, f2);
+}
+
+unittest(array)
+{
+  int val = 10;
+  EEPROM[2] = val;
+  uint8_t a = EEPROM[2];
+  assertEqual(10, a);
+}
+
+#endif
+
+unittest_main()

appveyor.yml

@@ -24,4 +24,4 @@ test_script:
   - bundle exec rspec --backtrace
   - cd SampleProjects\TestSomething
   - bundle install
-  - bundle exec arduino_ci_remote.rb
+  - bundle exec arduino_ci.rb