Merge pull request #183 from ianfixes/2020-10-16_suggestions

Suggested fixes

Author: ianfixes

Diff for: .rubocop.yml

@@ -31,6 +31,12 @@ Layout/ExtraSpacing:
 Layout/EndOfLine:
   EnforcedStyle: lf
 
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
 Metrics/LineLength:
   Description: Limit lines to 80 characters.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits

Diff for: .travis.yml

@@ -27,3 +27,9 @@ script:
    - cd SampleProjects/TestSomething
    - bundle install
    - bundle exec arduino_ci.rb
+   - cd ../NetworkLib
+   - cd scripts
+   - bash -x ./install.sh
+   - cd ..
+   - bundle install
+   - bundle exec arduino_ci.rb

Diff for: CHANGELOG.md

@@ -0,0 +1 @@
+depends=OnePointOhDummy,OnePointFiveDummy

Diff for: REFERENCE.md

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

Diff for: SampleProjects/DependOnSomething/library.properties

@@ -0,0 +1,3 @@
+unittest:
+  exclude_dirs:
+    - src/excludeThis

Diff for: SampleProjects/DependOnSomething/src/YesDeps.cpp

@@ -0,0 +1,10 @@
+name=TestSomething
+version=0.1.0
+author=Ian Katz <[email protected]>
+maintainer=Ian Katz <[email protected]>
+sentence=Arduino CI unit test example
+paragraph=A skeleton library demonstrating file exclusion
+category=Other
+url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/ExcludeSomething
+architectures=avr,esp8266
+includes=do-something.h

Diff for: SampleProjects/DependOnSomething/src/YesDeps.h

@@ -0,0 +1,4 @@
+#include "exclude-something.h"
+int excludeSomething(void) {
+  return -1;
+};

Diff for: SampleProjects/DependOnSomething/test/null.cpp

@@ -0,0 +1,3 @@
+#pragma once
+#include <Arduino.h>
+int excludeSomething(void);

Diff for: SampleProjects/ExcludeSomething/.arduino-ci.yml

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

Diff for: SampleProjects/ExcludeSomething/README.md

@@ -0,0 +1,11 @@
+unittest:
+  platforms:
+    - mega2560
+  libraries:
+    - "Ethernet"
+
+compile:
+  platforms:
+    - mega2560
+  libraries:
+    - "Ethernet"

Diff for: SampleProjects/ExcludeSomething/library.properties

@@ -0,0 +1 @@
+.bundle

Diff for: SampleProjects/ExcludeSomething/src/exclude-something.cpp

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'arduino_ci', path: '../../'

Diff for: SampleProjects/ExcludeSomething/src/exclude-something.h

@@ -0,0 +1,6 @@
+#include <NetworkLib.h>
+// if it seems bare, that's because it's only meant to
+// demonstrate compilation -- that references work
+void setup() {}
+
+void loop() {}

Diff for: SampleProjects/TestSomething/excludeThis/exclude-this.cpp renamed to SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.cpp

@@ -0,0 +1,10 @@
+name=Ethernet
+version=0.1.0
+author=James Foster <[email protected]>
+maintainer=James Foster <[email protected]>
+sentence=Sample Ethernet library to validate Client/Server mocks
+paragraph=Sample Ethernet library to validate Client/Server mocks
+category=Other
+url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/Ethernet
+architectures=avr,esp8266
+includes=NetworkLib.h

Diff for: SampleProjects/TestSomething/excludeThis/exclude-this.h renamed to SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.h

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# if we don't have an Ethernet library already (say, in new install or for an automated test),
+# then get the custom one we want to use for testing
+cd $(bundle exec arduino_library_location.rb)
+if [ ! -d ./Ethernet ] ; then
+  git clone https://github.com/Arduino-CI/Ethernet.git
+fi

Diff for: SampleProjects/ExcludeSomething/test/null.cpp

@@ -0,0 +1 @@
+#include "Ethernet.h"

Diff for: SampleProjects/NetworkLib/.arduino-ci.yml

@@ -0,0 +1,3 @@
+#pragma once
+
+#include <Arduino.h>

Diff for: SampleProjects/NetworkLib/.gitignore

@@ -0,0 +1,15 @@
+/*
+cd SampleProjects/NetworkLib
+bundle config --local path vendor/bundle
+bundle install
+bundle exec arduino_ci_remote.rb  --skip-compilation
+# bundle exec arduino_ci_remote.rb  --skip-examples-compilation
+*/
+
+#include <Arduino.h>
+#include <ArduinoUnitTests.h>
+#include <Ethernet.h>
+
+unittest(test) { assertEqual(EthernetNoHardware, Ethernet.hardwareStatus()); }
+
+unittest_main()

Diff for: SampleProjects/NetworkLib/Gemfile

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

Diff for: SampleProjects/NetworkLib/README.md

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

Diff for: SampleProjects/NetworkLib/examples/EthernetExample/EthernetExample.ino

@@ -1,6 +1,4 @@
 unittest:
-  exclude_dirs:
-    - excludeThis
   platforms:
     - uno
     - due

Diff for: SampleProjects/NetworkLib/library.properties

@@ -0,0 +1,87 @@
+#include <Arduino.h>
+#include <ArduinoUnitTests.h>
+#include <Client.h>
+#include <IPAddress.h>
+#include <Printable.h>
+#include <Server.h>
+#include <Udp.h>
+
+// Provide some rudamentary tests for these classes
+// They get more thoroughly tested in SampleProjects/NetworkLib
+
+unittest(Client) {
+  Client client;
+  assertEqual(0, client.available());         // subclass of Stream
+  assertEqual(0, client.availableForWrite()); // subclass of Print
+  String outData = "Hello, world!";
+  client.println(outData);
+  String inData = client.readString();
+  assertEqual(outData + "\r\n", inData);
+}
+
+unittest(IPAddress) {
+  IPAddress ipAddress0;
+  assertEqual(0, ipAddress0.asWord());
+  uint32_t one = 0x01020304;
+  IPAddress ipAddress1(one);
+  assertEqual(one, ipAddress1.asWord());
+  IPAddress ipAddress2(2, 3, 4, 5);
+  assertEqual(0x05040302, ipAddress2.asWord());
+  uint8_t bytes[] = {3, 4, 5, 6};
+  IPAddress ipAddress3(bytes);
+  assertEqual(0x06050403, ipAddress3.asWord());
+  uint8_t *pBytes = ipAddress1.raw_address();
+  assertEqual(*(pBytes + 0), 4);
+  assertEqual(*(pBytes + 1), 3);
+  assertEqual(*(pBytes + 2), 2);
+  assertEqual(*(pBytes + 3), 1);
+  IPAddress ipAddress1a(one);
+  assertTrue(ipAddress1 == ipAddress1a);
+  assertTrue(ipAddress1 != ipAddress2);
+  assertEqual(1, ipAddress1[3]);
+  ipAddress1[1] = 11;
+  assertEqual(11, ipAddress1[1]);
+  assertEqual(1, ipAddress0 + 1);
+}
+
+class TestPrintable : public Printable {
+public:
+  virtual size_t printTo(Print &p) const {
+    p.print("TestPrintable");
+    return 13;
+  }
+};
+
+unittest(Printable) {
+  TestPrintable printable;
+  Client client;
+  client.print(printable);
+  assertEqual("TestPrintable", client.readString());
+}
+
+class TestServer : public Server {
+public:
+  uint8_t data;
+  virtual size_t write(uint8_t value) {
+    data = value;
+    return 1;
+  };
+};
+
+unittest(Server) {
+  TestServer server;
+  server.write(67);
+  assertEqual(67, server.data);
+}
+
+unittest(Udp) {
+  UDP udp;
+  assertEqual(0, udp.available());         // subclass of Stream
+  assertEqual(0, udp.availableForWrite()); // subclass of Print
+  String outData = "Hello, world!";
+  udp.println(outData);
+  String inData = udp.readString();
+  assertEqual(outData + "\r\n", inData);
+}
+
+unittest_main()