add doc and test for CI

Author: d-a-v

docs/sketch-build-process.md

@@ -27,6 +27,9 @@ compiler:
   rare cases, prototype generation may fail for some functions. To work around this, you can provide your own prototypes
   for these functions.
 - `#line` directives are added to make warning or error messages reflect the original sketch layout.
+- Special and optional sketch variables named ARDUIFINE and ARDUINOGLOBAL are parsed, and their content is used to
+  provide more arguments to the compiler commands. Those arguments are used for every compiled source file, including
+  the core, internal and external libraries. Their content is displayed in the message area.
 
 No pre-processing is done to files in a sketch with any extension other than .ino or .pde. Additionally, .h files in the
 sketch are not automatically #included from the main sketch file. Further, if you want to call functions defined in a .c

legacy/builder/test/builder_test.go

@@ -43,6 +43,25 @@ func prepareBuilderTestContext(t *testing.T, sketchPath *paths.Path, fqbn string
 	}
 }
 
+func TestBuilderArduifine(t *testing.T) {
+	DownloadCoresAndToolsAndLibraries(t)
+
+	ctx := prepareBuilderTestContext(t, paths.New("sketch_arduifine", "sketch_arduifine.ino"), "arduino:avr:uno")
+	ctx.DebugLevel = 10
+
+	buildPath := SetupBuildPath(t, ctx)
+	defer buildPath.RemoveAll()
+
+	// Run builder
+	command := builder.Builder{}
+	err := command.Run(ctx)
+	NoError(t, err)
+
+	exist, err := buildPath.Join("sketch_arduifine.ino.hex").ExistCheck()
+	NoError(t, err)
+	require.True(t, exist)
+}
+
 func TestBuilderEmptySketch(t *testing.T) {
 	DownloadCoresAndToolsAndLibraries(t)
 

legacy/builder/test/libraries/lib4arduifine/lib4arduifine.cpp

@@ -0,0 +1,8 @@
+
+#include <lib4arduifine.h>
+
+#if MYVERSION == 1337
+#pragma message "arduifine: MYVERSION is correctly defined"
+#else
+#error arduifine: MYVERSION is not correctly defined
+#endif

legacy/builder/test/libraries/lib4arduifine/lib4arduifine.h

@@ -66,7 +66,7 @@ func TestLoadLibrariesAVR(t *testing.T) {
 	require.True(t, Abs(t, paths.New("libraries")).EquivalentTo(librariesFolders[2].Path))
 
 	libs := extractLibraries(ctx)
-	require.Equal(t, 24, len(libs))
+	require.Equal(t, 25, len(libs))
 
 	sort.Sort(ByLibraryName(libs))
 
@@ -176,7 +176,7 @@ func TestLoadLibrariesSAM(t *testing.T) {
 	require.True(t, Abs(t, paths.New("libraries")).EquivalentTo(librariesFolders[2].Path))
 
 	libraries := extractLibraries(ctx)
-	require.Equal(t, 22, len(libraries))
+	require.Equal(t, 23, len(libraries))
 
 	sort.Sort(ByLibraryName(libraries))
 

legacy/builder/test/libraries_loader_test.go

@@ -0,0 +1,7 @@
+
+#include <lib4arduifine.h>
+
+const char* ARDUIFINEtest = "MYVERSION = 1337";
+
+void setup() {}
+void loop() {}