Add support for .tpp and .ipp Sketch file extensions (#1316)

* added '.tpp' file ext to known list

* Add support for .ipp Sketch files extension

* Add tests for new .tpp and .ipp extensions suppport

Co-authored-by: Silvano Cerza <[email protected]>

Author: tshcherban

Diff for: arduino/builder/sketch_test.go

@@ -289,3 +289,35 @@ func TestSketchWithMarkdownAsciidocJson(t *testing.T) {
 	require.Equal(t, "foo.json", filepath.Base(sketch.RootFolderFiles[1].Path))
 	require.Equal(t, "foo.md", filepath.Base(sketch.RootFolderFiles[2].Path))
 }
+
+func TestSketchWithTppFile(t *testing.T) {
+	sketchPath := filepath.Join("testdata", t.Name())
+	mainFilePath := filepath.Join(sketchPath, t.Name()+".ino")
+
+	sketch, err := builder.SketchLoad(sketchPath, "")
+	require.NotNil(t, sketch)
+	require.NoError(t, err)
+	require.Equal(t, sketchPath, sketch.LocationPath)
+	require.Equal(t, mainFilePath, sketch.MainFile.Path)
+	require.Len(t, sketch.OtherSketchFiles, 0)
+	require.Len(t, sketch.AdditionalFiles, 1)
+	require.Equal(t, "template.tpp", filepath.Base(sketch.AdditionalFiles[0].Path))
+	require.Len(t, sketch.RootFolderFiles, 1)
+	require.Equal(t, "template.tpp", filepath.Base(sketch.RootFolderFiles[0].Path))
+}
+
+func TestSketchWithIppFile(t *testing.T) {
+	sketchPath := filepath.Join("testdata", t.Name())
+	mainFilePath := filepath.Join(sketchPath, t.Name()+".ino")
+
+	sketch, err := builder.SketchLoad(sketchPath, "")
+	require.NotNil(t, sketch)
+	require.NoError(t, err)
+	require.Equal(t, sketchPath, sketch.LocationPath)
+	require.Equal(t, mainFilePath, sketch.MainFile.Path)
+	require.Len(t, sketch.OtherSketchFiles, 0)
+	require.Len(t, sketch.AdditionalFiles, 1)
+	require.Equal(t, "template.ipp", filepath.Base(sketch.AdditionalFiles[0].Path))
+	require.Len(t, sketch.RootFolderFiles, 1)
+	require.Equal(t, "template.ipp", filepath.Base(sketch.RootFolderFiles[0].Path))
+}

Diff for: arduino/builder/testdata/TestSketchWithIppFile/TestSketchWithIppFile.ino

@@ -0,0 +1,4 @@
+#include "template.ipp"
+
+void setup() {}
+void loop() {}

Diff for: arduino/builder/testdata/TestSketchWithIppFile/template.ipp

@@ -0,0 +1,4 @@
+#include "template.tpp"
+
+void setup() {}
+void loop() {}

Diff for: arduino/builder/testdata/TestSketchWithTppFile/TestSketchWithTppFile.ino

@@ -39,6 +39,8 @@ var (
 		".adoc": empty,
 		".md":   empty,
 		".json": empty,
+		".tpp":  empty,
+		".ipp":  empty,
 	}
 
 	// SourceFilesValidExtensions lists valid extensions for source files (no headers)

Diff for: arduino/builder/testdata/TestSketchWithTppFile/template.tpp

@@ -138,3 +138,37 @@ func TestSketchWithMarkdownAsciidocJson(t *testing.T) {
 	require.Equal(t, "foo.json", filepath.Base(sketch.RootFolderFiles[1].Path))
 	require.Equal(t, "foo.md", filepath.Base(sketch.RootFolderFiles[2].Path))
 }
+
+func TestSketchWithTppFile(t *testing.T) {
+	sketchPath := paths.New("testdata", "SketchWithTppFile")
+	mainFilePath := sketchPath.Join("SketchWithTppFile.ino").String()
+	templateFile := sketchPath.Join("template.tpp").String()
+
+	sketch, err := New(sketchPath.String(), mainFilePath, "", []string{mainFilePath, templateFile})
+	require.NotNil(t, sketch)
+	require.NoError(t, err)
+	require.Equal(t, sketchPath.String(), sketch.LocationPath)
+	require.Equal(t, mainFilePath, sketch.MainFile.Path)
+	require.Len(t, sketch.OtherSketchFiles, 0)
+	require.Len(t, sketch.AdditionalFiles, 1)
+	require.Equal(t, "template.tpp", filepath.Base(sketch.AdditionalFiles[0].Path))
+	require.Len(t, sketch.RootFolderFiles, 1)
+	require.Equal(t, "template.tpp", filepath.Base(sketch.RootFolderFiles[0].Path))
+}
+
+func TestSketchWithIppFile(t *testing.T) {
+	sketchPath := paths.New("testdata", "SketchWithIppFile")
+	mainFilePath := sketchPath.Join("SketchWithIppFile.ino").String()
+	templateFile := sketchPath.Join("template.ipp").String()
+
+	sketch, err := New(sketchPath.String(), mainFilePath, "", []string{mainFilePath, templateFile})
+	require.NotNil(t, sketch)
+	require.NoError(t, err)
+	require.Equal(t, sketchPath.String(), sketch.LocationPath)
+	require.Equal(t, mainFilePath, sketch.MainFile.Path)
+	require.Len(t, sketch.OtherSketchFiles, 0)
+	require.Len(t, sketch.AdditionalFiles, 1)
+	require.Equal(t, "template.ipp", filepath.Base(sketch.AdditionalFiles[0].Path))
+	require.Len(t, sketch.RootFolderFiles, 1)
+	require.Equal(t, "template.ipp", filepath.Base(sketch.RootFolderFiles[0].Path))
+}

Diff for: arduino/globals/globals.go

@@ -0,0 +1,4 @@
+#include "template.ipp"
+
+void setup() {}
+void loop() {}

Diff for: arduino/sketch/sketch_test.go

@@ -0,0 +1,4 @@
+#include "template.tpp"
+
+void setup() {}
+void loop() {}

Diff for: arduino/sketch/testdata/SketchWithIppFile/SketchWithIppFile.ino

@@ -1129,3 +1129,29 @@ def test_compile_with_esp8266_bundled_libraries(run_command, data_dir, copy_sket
         f" Not used: {cli_installed_lib_path}",
     ]
     assert "\n".join(expected_output) not in res.stdout
+
+
+def test_compile_sketch_with_tpp_file_include(run_command, copy_sketch):
+    assert run_command("update")
+
+    # Download latest AVR
+    run_command("core install arduino:avr")
+
+    sketch_name = "sketch_with_tpp_file_include"
+    sketch_path = copy_sketch(sketch_name)
+    fqbn = "arduino:avr:uno"
+
+    assert run_command(f"compile -b {fqbn} {sketch_path} --verbose")
+
+
+def test_compile_sketch_with_ipp_file_include(run_command, copy_sketch):
+    assert run_command("update")
+
+    # Download latest AVR
+    run_command("core install arduino:avr")
+
+    sketch_name = "sketch_with_ipp_file_include"
+    sketch_path = copy_sketch(sketch_name)
+    fqbn = "arduino:avr:uno"
+
+    assert run_command(f"compile -b {fqbn} {sketch_path} --verbose")

Diff for: arduino/sketch/testdata/SketchWithIppFile/template.ipp

@@ -0,0 +1,4 @@
+#include "template.ipp"
+
+void setup() {}
+void loop() {}

Diff for: arduino/sketch/testdata/SketchWithTppFile/SketchWithTppFile.ino

@@ -0,0 +1,4 @@
+#include "template.tpp"
+
+void setup() {}
+void loop() {}