Skip to content

Relax library matching rules when detecting libraries #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 1, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions src/arduino.cc/builder/resolve_library.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,14 @@ func ResolveLibrary(ctx *types.Context, header string) *types.Library {
return nil
}

if len(libraries) == 1 {
markImportedLibrary[libraries[0]] = true
return libraries[0]
}

if markImportedLibraryContainsOneOfCandidates(markImportedLibrary, libraries) {
return nil
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this should actually never occur at all, if the header is available, it is never returned as missing by the preprocessor (this was different when include scanning was still regex-based instead of preprocessor-based). Keeping this if in might be a good idea, though, but perhaps it should be marked as "just in case" with a comment.

if len(libraries) == 1 {
return libraries[0]
}

reverse(libraries)

var library *types.Library
Expand Down Expand Up @@ -92,7 +91,6 @@ func ResolveLibrary(ctx *types.Context, header string) *types.Library {

libraryResolutionResults[header] = types.LibraryResolutionResult{Library: library, NotUsedLibraries: filterOutLibraryFrom(libraries, library)}

markImportedLibrary[library] = true
return library
}

Expand Down
71 changes: 71 additions & 0 deletions src/arduino.cc/builder/resolve_library_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* This file is part of Arduino Builder.
*
* Arduino Builder is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As a special exception, you may use this file as part of a free software
* library without restriction. Specifically, if other files instantiate
* templates or use macros or inline functions from this file, or you compile
* this file and link it with other files to produce an executable, this
* file does not by itself cause the resulting executable to be covered by
* the GNU General Public License. This exception does not however
* invalidate any other reasons why the executable file might be covered by
* the GNU General Public License.
*
* Copyright 2017 Arduino LLC (http://www.arduino.cc/)
*/

package builder

import (
"testing"

"arduino.cc/builder/types"

"github.com/stretchr/testify/require"
)

func TestFindBestLibraryWithHeader(t *testing.T) {
l1 := &types.Library{Name: "Calculus Lib"}
l2 := &types.Library{Name: "Calculus Lib-master"}
l3 := &types.Library{Name: "Calculus Lib Improved"}
l4 := &types.Library{Name: "Another Calculus Lib"}
l5 := &types.Library{Name: "Yet Another Calculus Lib Improved"}
l6 := &types.Library{Name: "AnotherLib"}

// Test exact name matching
res := findBestLibraryWithHeader("calculus_lib.h", []*types.Library{l6, l5, l4, l3, l2, l1})
require.Equal(t, l1.Name, res.Name)

// Test exact name with "-master" postfix matching
res = findBestLibraryWithHeader("calculus_lib.h", []*types.Library{l6, l5, l4, l3, l2})
require.Equal(t, l2.Name, res.Name)

// Test prefix matching
res = findBestLibraryWithHeader("calculus_lib.h", []*types.Library{l6, l5, l4, l3})
require.Equal(t, l3.Name, res.Name)

// Test postfix matching
res = findBestLibraryWithHeader("calculus_lib.h", []*types.Library{l6, l5, l4})
require.Equal(t, l4.Name, res.Name)

// Test "contains"" matching
res = findBestLibraryWithHeader("calculus_lib.h", []*types.Library{l6, l5})
require.Equal(t, l5.Name, res.Name)

// Test none matching
res = findBestLibraryWithHeader("calculus_lib.h", []*types.Library{l6})
require.Nil(t, res)
}