Mock for SD (#11)

* We now have an in-memory mock (test double) for the file system!

* Add GitHub Action (fix #8)

* Update format.

* Format examples.

* Add include for `assert()`.

* Use proper delete to avoid AddressSanitizer: alloc-dealloc-mismatch (operator new [] vs operator delete).

* Do proper garbage collection when removing all files.

* Update format.

Co-authored-by: James Foster <[email protected]>

Author: James Foster

.github/workflows/arduino_ci.yml

@@ -0,0 +1,12 @@
+---
+name: Arduino CI
+
+on: [push, pull_request]
+
+jobs:
+  arduino_ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: Arduino-CI/[email protected]

.github/workflows/format.yml

@@ -0,0 +1,15 @@
+name: test-clang-format
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: DoozyX/[email protected]
+      with:
+        source: './'
+        extensions: 'c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx,ino'
+        clangFormatVersion: 9

.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 .bundle
 vendor
 *.cpp.bin*
+.vscode

examples/CardInfo/CardInfo.ino

@@ -3,24 +3,23 @@
 
   This example shows how use the utility libraries on which the'
   SD library is based in order to get info about your SD card.
-  Very useful for testing a card when you're not sure whether its working or not.
-  Pin numbers reflect the default SPI pins for Uno and Nano models
-  The circuit:
-    SD card attached to SPI bus as follows:
+  Very useful for testing a card when you're not sure whether its working or
+ not. Pin numbers reflect the default SPI pins for Uno and Nano models The
+ circuit: SD card attached to SPI bus as follows:
  ** SDO - pin 11 on Arduino Uno/Duemilanove/Diecimila
  ** SDI - pin 12 on Arduino Uno/Duemilanove/Diecimila
  ** CLK - pin 13 on Arduino Uno/Duemilanove/Diecimila
  ** CS - depends on your SD card shield or module.
- 		Pin 10 used here for consistency with other Arduino examples
+                Pin 10 used here for consistency with other Arduino examples
 
   created  28 Mar 2011
   by Limor Fried
   modified 24 July 2020
   by Tom Igoe
 */
 // include the SD library:
-#include <SPI.h>
 #include <SD.h>
+#include <SPI.h>
 
 // set up variables using the SD utility library functions:
 Sd2Card card;
@@ -42,7 +41,6 @@ void setup() {
     ; // wait for serial port to connect. Needed for native USB port only
   }
 
-
   Serial.print("\nInitializing SD card...");
 
   // we'll use the initialization code from the utility libraries
@@ -51,8 +49,10 @@ void setup() {
     Serial.println("initialization failed. Things to check:");
     Serial.println("* is a card inserted?");
     Serial.println("* is your wiring correct?");
-    Serial.println("* did you change the chipSelect pin to match your shield or module?");
-    while (1);
+    Serial.println(
+        "* did you change the chipSelect pin to match your shield or module?");
+    while (1)
+      ;
   } else {
     Serial.println("Wiring is correct and a card is present.");
   }
@@ -61,23 +61,26 @@ void setup() {
   Serial.println();
   Serial.print("Card type:         ");
   switch (card.type()) {
-    case SD_CARD_TYPE_SD1:
-      Serial.println("SD1");
-      break;
-    case SD_CARD_TYPE_SD2:
-      Serial.println("SD2");
-      break;
-    case SD_CARD_TYPE_SDHC:
-      Serial.println("SDHC");
-      break;
-    default:
-      Serial.println("Unknown");
+  case SD_CARD_TYPE_SD1:
+    Serial.println("SD1");
+    break;
+  case SD_CARD_TYPE_SD2:
+    Serial.println("SD2");
+    break;
+  case SD_CARD_TYPE_SDHC:
+    Serial.println("SDHC");
+    break;
+  default:
+    Serial.println("Unknown");
   }
 
-  // Now we will try to open the 'volume'/'partition' - it should be FAT16 or FAT32
+  // Now we will try to open the 'volume'/'partition' - it should be FAT16 or
+  // FAT32
   if (!volume.init(card)) {
-    Serial.println("Could not find FAT16/FAT32 partition.\nMake sure you've formatted the card");
-    while (1);
+    Serial.println("Could not find FAT16/FAT32 partition.\nMake sure you've "
+                   "formatted the card");
+    while (1)
+      ;
   }
 
   Serial.print("Clusters:          ");
@@ -94,9 +97,9 @@ void setup() {
   Serial.print("Volume type is:    FAT");
   Serial.println(volume.fatType(), DEC);
 
-  volumesize = volume.blocksPerCluster();    // clusters are collections of blocks
-  volumesize *= volume.clusterCount();       // we'll have a lot of clusters
-  volumesize /= 2;                           // SD card blocks are always 512 bytes (2 blocks are 1KB)
+  volumesize = volume.blocksPerCluster(); // clusters are collections of blocks
+  volumesize *= volume.clusterCount();    // we'll have a lot of clusters
+  volumesize /= 2; // SD card blocks are always 512 bytes (2 blocks are 1KB)
   Serial.print("Volume size (Kb):  ");
   Serial.println(volumesize);
   Serial.print("Volume size (Mb):  ");
@@ -113,5 +116,4 @@ void setup() {
   root.close();
 }
 
-void loop(void) {
-}
+void loop(void) {}

examples/Datalogger/Datalogger.ino

@@ -12,7 +12,7 @@
  ** SDI - pin 12
  ** CLK - pin 13
  ** CS - depends on your SD card shield or module.
- 		Pin 10 used here for consistency with other Arduino examples
+                Pin 10 used here for consistency with other Arduino examples
     (for MKRZero SD: SDCARD_SS_PIN)
 
   created  24 Nov 2010
@@ -23,26 +23,30 @@
 
 */
 
-#include <SPI.h>
 #include <SD.h>
+#include <SPI.h>
 
 const int chipSelect = 10;
 
 void setup() {
   // Open serial communications and wait for port to open:
   Serial.begin(9600);
   // wait for Serial Monitor to connect. Needed for native USB port boards only:
-  while (!Serial);
+  while (!Serial)
+    ;
 
   Serial.print("Initializing SD card...");
 
   if (!SD.begin(chipSelect)) {
     Serial.println("initialization failed. Things to check:");
     Serial.println("1. is a card inserted?");
     Serial.println("2. is your wiring correct?");
-    Serial.println("3. did you change the chipSelect pin to match your shield or module?");
-    Serial.println("Note: press reset or reopen this serial monitor after fixing your issue!");
-    while (true);
+    Serial.println(
+        "3. did you change the chipSelect pin to match your shield or module?");
+    Serial.println("Note: press reset or reopen this serial monitor after "
+                   "fixing your issue!");
+    while (true)
+      ;
   }
 
   Serial.println("initialization done.");

examples/DumpFile/DumpFile.ino

@@ -11,7 +11,7 @@
  ** SDI - pin 12
  ** CLK - pin 13
  ** CS - depends on your SD card shield or module.
- 		Pin 10 used here for consistency with other Arduino examples
+                Pin 10 used here for consistency with other Arduino examples
    (for MKRZero SD: SDCARD_SS_PIN)
 
   created  22 December 2010
@@ -29,17 +29,21 @@ void setup() {
   // Open serial communications and wait for port to open:
   Serial.begin(9600);
   // wait for Serial Monitor to connect. Needed for native USB port boards only:
-  while (!Serial);
+  while (!Serial)
+    ;
 
   Serial.print("Initializing SD card...");
 
   if (!SD.begin(chipSelect)) {
     Serial.println("initialization failed. Things to check:");
     Serial.println("1. is a card inserted?");
     Serial.println("2. is your wiring correct?");
-    Serial.println("3. did you change the chipSelect pin to match your shield or module?");
-    Serial.println("Note: press reset or reopen this serial monitor after fixing your issue!");
-    while (true);
+    Serial.println(
+        "3. did you change the chipSelect pin to match your shield or module?");
+    Serial.println("Note: press reset or reopen this serial monitor after "
+                   "fixing your issue!");
+    while (true)
+      ;
   }
 
   Serial.println("initialization done.");
@@ -61,5 +65,4 @@ void setup() {
   }
 }
 
-void loop() {
-}
+void loop() {}

examples/Files/Files.ino

@@ -9,7 +9,7 @@
  ** SDI - pin 12
  ** CLK - pin 13
  ** CS - depends on your SD card shield or module.
- 		Pin 10 used here for consistency with other Arduino examples
+                Pin 10 used here for consistency with other Arduino examples
     (for MKRZero SD: SDCARD_SS_PIN)
 
   created   Nov 2010
@@ -28,13 +28,15 @@ void setup() {
   // Open serial communications and wait for port to open:
   Serial.begin(9600);
   // wait for Serial Monitor to connect. Needed for native USB port boards only:
-while (!Serial);
+  while (!Serial)
+    ;
 
   Serial.print("Initializing SD card...");
 
   if (!SD.begin(chipSelect)) {
     Serial.println("initialization failed!");
-    while (1);
+    while (1)
+      ;
   }
   Serial.println("initialization done.");
 

examples/NonBlockingWrite/NonBlockingWrite.ino

@@ -55,17 +55,21 @@ void setup() {
   pinMode(LED_BUILTIN, OUTPUT);
 
   // wait for Serial Monitor to connect. Needed for native USB port boards only:
-  while (!Serial);
+  while (!Serial)
+    ;
 
   Serial.print("Initializing SD card...");
 
   if (!SD.begin(chipSelect)) {
     Serial.println("initialization failed. Things to check:");
     Serial.println("1. is a card inserted?");
     Serial.println("2. is your wiring correct?");
-    Serial.println("3. did you change the chipSelect pin to match your shield or module?");
-    Serial.println("Note: press reset or reopen this serial monitor after fixing your issue!");
-    while (true);
+    Serial.println(
+        "3. did you change the chipSelect pin to match your shield or module?");
+    Serial.println("Note: press reset or reopen this serial monitor after "
+                   "fixing your issue!");
+    while (true)
+      ;
   }
 
   Serial.println("initialization done.");
@@ -79,7 +83,8 @@ void setup() {
   if (!myFile) {
     Serial.print("error opening ");
     Serial.println(filename);
-    while (true);
+    while (true)
+      ;
   }
 
   // add some new lines to start

examples/ReadWrite/ReadWrite.ino

@@ -27,17 +27,21 @@ void setup() {
   // Open serial communications and wait for port to open:
   Serial.begin(9600);
   // wait for Serial Monitor to connect. Needed for native USB port boards only:
-  while (!Serial);
+  while (!Serial)
+    ;
 
   Serial.print("Initializing SD card...");
 
   if (!SD.begin(chipSelect)) {
     Serial.println("initialization failed. Things to check:");
     Serial.println("1. is a card inserted?");
     Serial.println("2. is your wiring correct?");
-    Serial.println("3. did you change the chipSelect pin to match your shield or module?");
-    Serial.println("Note: press reset or reopen this serial monitor after fixing your issue!");
-    while (true);
+    Serial.println(
+        "3. did you change the chipSelect pin to match your shield or module?");
+    Serial.println("Note: press reset or reopen this serial monitor after "
+                   "fixing your issue!");
+    while (true)
+      ;
   }
 
   Serial.println("initialization done.");

examples/listfiles/listfiles.ino

@@ -11,7 +11,7 @@
  ** SDI - pin 12
  ** CLK - pin 13
  ** CS - depends on your SD card shield or module.
- 		Pin 10 used here for consistency with other Arduino examples
+                Pin 10 used here for consistency with other Arduino examples
     (for MKRZero SD: SDCARD_SS_PIN)
 
   created   Nov 2010
@@ -22,7 +22,7 @@
   by Scott Fitzgerald
   modified 24 July 2020
   by Tom Igoe
-  
+
   This example code is in the public domain.
 
 */
@@ -32,20 +32,24 @@ const int chipSelect = 10;
 File root;
 
 void setup() {
- // Open serial communications and wait for port to open:
+  // Open serial communications and wait for port to open:
   Serial.begin(9600);
   // wait for Serial Monitor to connect. Needed for native USB port boards only:
-  while (!Serial);
+  while (!Serial)
+    ;
 
   Serial.print("Initializing SD card...");
 
   if (!SD.begin(chipSelect)) {
     Serial.println("initialization failed. Things to check:");
     Serial.println("1. is a card inserted?");
     Serial.println("2. is your wiring correct?");
-    Serial.println("3. did you change the chipSelect pin to match your shield or module?");
-    Serial.println("Note: press reset or reopen this serial monitor after fixing your issue!");
-    while (true);
+    Serial.println(
+        "3. did you change the chipSelect pin to match your shield or module?");
+    Serial.println("Note: press reset or reopen this serial monitor after "
+                   "fixing your issue!");
+    while (true)
+      ;
   }
 
   Serial.println("initialization done.");
@@ -64,8 +68,8 @@ void loop() {
 void printDirectory(File dir, int numTabs) {
   while (true) {
 
-    File entry =  dir.openNextFile();
-    if (! entry) {
+    File entry = dir.openNextFile();
+    if (!entry) {
       // no more files
       break;
     }