Skip to content

Commit

Permalink
Added integration test
Browse files Browse the repository at this point in the history
  • Loading branch information
cmaglie committed Jan 20, 2025
1 parent cf110ab commit 8a632bf
Show file tree
Hide file tree
Showing 7 changed files with 126 additions and 0 deletions.
110 changes: 110 additions & 0 deletions internal/integrationtest/compile_4/lib_discovery_caching_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
// This file is part of arduino-cli.
//
// Copyright 2023 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to [email protected].

package compile_test

import (
"testing"

"github.com/arduino/arduino-cli/internal/integrationtest"
"github.com/arduino/go-paths-helper"
"github.com/stretchr/testify/require"
"go.bug.st/testifyjson/requirejson"
)

func TestLibDiscoveryCache(t *testing.T) {
env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
t.Cleanup(env.CleanUp)

// Install Arduino AVR Boards
_, _, err := cli.Run("core", "install", "arduino:[email protected]")
require.NoError(t, err)

// Copy the testdata sketchbook
testdata, err := paths.New("testdata", "libraries_discovery_caching").Abs()
require.NoError(t, err)
sketchbook := cli.SketchbookDir()
require.NoError(t, sketchbook.RemoveAll())
require.NoError(t, testdata.CopyDirTo(cli.SketchbookDir()))

buildpath, err := paths.MkTempDir("", "tmpbuildpath")
require.NoError(t, err)
t.Cleanup(func() { buildpath.RemoveAll() })

{
sketchA := sketchbook.Join("SketchA")
{
outjson, _, err := cli.Run("compile", "-v", "-b", "arduino:avr:uno", "--build-path", buildpath.String(), "--json", sketchA.String())
require.NoError(t, err)
j := requirejson.Parse(t, outjson)
j.MustContain(`{"builder_result":{
"used_libraries": [
{ "name": "LibA" },
{ "name": "LibB" }
],
}}`)
}

// Update SketchA
require.NoError(t, sketchA.Join("SketchA.ino").WriteFile([]byte(`
#include <LibC.h>
#include <LibA.h>
void setup() {}
void loop() {libAFunction();}
`)))

{
// This compile should FAIL!
outjson, _, err := cli.Run("compile", "-v", "-b", "arduino:avr:uno", "--build-path", buildpath.String(), "--json", sketchA.String())
require.Error(t, err)
j := requirejson.Parse(t, outjson)
j.MustContain(`{
"builder_result":{
"used_libraries": [
{ "name": "LibC" },
{ "name": "LibA" }
],
"diagnostics": [
{
"severity": "ERROR",
"message": "'libAFunction' was not declared in this scope\n void loop() {libAFunction();}\n ^~~~~~~~~~~~"
}
]
}}`)
j.Query(".compiler_out").MustContain(`"The list of included libraries has been changed... rebuilding all libraries."`)
}

{
// This compile should FAIL!
outjson, _, err := cli.Run("compile", "-v", "-b", "arduino:avr:uno", "--build-path", buildpath.String(), "--json", sketchA.String())
require.Error(t, err)
j := requirejson.Parse(t, outjson)
j.MustContain(`{
"builder_result":{
"used_libraries": [
{ "name": "LibC" },
{ "name": "LibA" }
],
"diagnostics": [
{
"severity": "ERROR",
"message": "'libAFunction' was not declared in this scope\n void loop() {libAFunction();}\n ^~~~~~~~~~~~"
}
]
}}`)
j.Query(".compiler_out").MustNotContain(`"The list of included libraries has changed... rebuilding all libraries."`)
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#include <LibA.h>
void setup() {}
void loop() {libAFunction();}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

#include <LibB.h>

#ifndef CHECK
void libAFunction();
#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#include <LibB.h>

#ifndef CHECK
void libAFunction() {}
#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

#define CHECK

0 comments on commit 8a632bf

Please sign in to comment.