Skip to content

Use JSON pointer as package component ID when standard ID component empty #192

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.

Sign up for GitHub

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 1 commit into from
Jun 14, 2021
Merged

Use JSON pointer as package component ID when standard ID component empty #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 12 additions & 5 deletions internal/project/projectdata/packageindex.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,24 +127,31 @@ func getPackageIndexData(interfaceObject map[string]interface{}, pointerPrefix s
}

objectID := func() string {
// In the event missing data prevents creating a standard reference ID for the data, use the JSON pointer.
fallbackID := interfaceElementData.JSONPointer

if iDPrefix != "" && strings.HasPrefix(iDPrefix, pointerPrefix) {
// Parent object uses fallback ID, so this one must even if it was possible to generate a true suffix.
return interfaceElementData.JSONPointer
return fallbackID
}
iD := iDPrefix

iDSuffix, ok := object[iDKey].(string)
if !ok {
// Use fallback ID.
return interfaceElementData.JSONPointer
return fallbackID
}
if iDSuffix == "" {
return fallbackID
}
iD += iDSuffix

if versionKey != "" {
iDVersion, ok := object[versionKey].(string)
if !ok {
// Use fallback ID.
return interfaceElementData.JSONPointer
return fallbackID
}
if iDVersion == "" {
return fallbackID
}
iD += "@" + iDVersion
}
Expand Down
75 changes: 75 additions & 0 deletions internal/project/projectdata/packageindex_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,81 @@ func TestInitializeForPackageIndex(t *testing.T) {
},
},
},
{
testName: "Empty IDs",
path: packageIndexTestDataPath.Join("empty-ids", "package_foo_index.json"),
packageIndexAssertion: assert.NotNil,
packageIndexLoadErrorAssertion: assert.Nil,
packageIndexCLILoadErrorAssertion: assert.Nil,
packageIndexPackagesAssertion: assert.NotNil,
packageIndexPackagesDataAssertion: []PackageIndexData{
{
ID: "/packages/0",
JSONPointer: "/packages/0",
},
{
ID: "foopackager2",
JSONPointer: "/packages/1",
},
},
packageIndexPlatformsAssertion: assert.NotNil,
packageIndexPlatformsDataAssertion: []PackageIndexData{
{
ID: "/packages/0/platforms/0",
JSONPointer: "/packages/0/platforms/0",
},
{
ID: "/packages/0/platforms/1",
JSONPointer: "/packages/0/platforms/1",
},
{
ID: "/packages/1/platforms/0",
JSONPointer: "/packages/1/platforms/0",
},
{
ID: "/packages/1/platforms/1",
JSONPointer: "/packages/1/platforms/1",
},
},
packageIndexToolsAssertion: assert.NotNil,
packageIndexToolsDataAssertion: []PackageIndexData{
{
ID: "/packages/1/tools/0",
JSONPointer: "/packages/1/tools/0",
},
{
ID: "/packages/1/tools/1",
JSONPointer: "/packages/1/tools/1",
},
{
ID: "foopackager2:[email protected]",
JSONPointer: "/packages/1/tools/2",
},
},
packageIndexSystemsAssertion: assert.NotNil,
packageIndexSystemsDataAssertion: []PackageIndexData{
{
ID: "/packages/1/tools/0/systems/0",
JSONPointer: "/packages/1/tools/0/systems/0",
},
{
ID: "/packages/1/tools/0/systems/1",
JSONPointer: "/packages/1/tools/0/systems/1",
},
{
ID: "/packages/1/tools/1/systems/0",
JSONPointer: "/packages/1/tools/1/systems/0",
},
{
ID: "/packages/1/tools/1/systems/1",
JSONPointer: "/packages/1/tools/1/systems/1",
},
{
ID: "/packages/1/tools/2/systems/0",
JSONPointer: "/packages/1/tools/2/systems/0",
},
},
},
{
testName: "Invalid package index",
path: packageIndexTestDataPath.Join("invalid-package-index", "package_foo_index.json"),
Expand Down
186 changes: 186 additions & 0 deletions internal/project/projectdata/testdata/packageindexes/empty-ids/package_foo_index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
{
"packages": [
{
"name": "",
"maintainer": "Jane Developer",
"websiteURL": "https://github.com/janedeveloper/myboard",
"email": "[email protected]",
"help": {
"online": "http://example.com/forum/myboard"
},
"platforms": [
{
"name": "My Board",
"architecture": "avr",
"version": "1.0.0",
"category": "Contributed",
"help": {
"online": "http://example.com/forum/myboard"
},
"url": "https://janedeveloper.github.io/myboard/myboard-1.0.0.zip",
"archiveFileName": "myboard-1.0.0.zip",
"checksum": "SHA-256:ec3ff8a1dc96d3ba6f432b9b837a35fd4174a34b3d2927de1d51010e8b94f9f1",
"size": "15005",
"boards": [{ "name": "My Board" }, { "name": "My Board Pro" }],
"toolsDependencies": [
{
"packager": "arduino",
"name": "avr-gcc",
"version": "4.8.1-arduino5"
},
{
"packager": "arduino",
"name": "avrdude",
"version": "6.0.1-arduino5"
}
]
},
{
"name": "My Board",
"architecture": "avr",
"version": "1.0.1",
"category": "Contributed",
"help": {
"online": "http://example.com/forum/myboard"
},
"url": "https://janedeveloper.github.io/myboard/myboard-1.0.1.zip",
"archiveFileName": "myboard-1.0.1.zip",
"checksum": "SHA-256:9c86ee28a7ce9fe33e8b07ec643316131e0031b0d22e63bb398902a5fdadbca9",
"size": "15125",
"boards": [{ "name": "My Board" }, { "name": "My Board Pro" }],
"toolsDependencies": [
{
"packager": "arduino",
"name": "avr-gcc",
"version": "4.8.1-arduino5"
},
{
"packager": "arduino",
"name": "avrdude",
"version": "6.0.1-arduino5"
}
]
}
],
"tools": []
},
{
"name": "foopackager2",
"maintainer": "Jane Developer",
"websiteURL": "https://github.com/janedeveloper/myboard",
"email": "[email protected]",
"help": {
"online": "http://example.com/forum/myboard"
},
"platforms": [
{
"name": "My Board",
"architecture": "",
"version": "2.0.0",
"category": "Contributed",
"help": {
"online": "http://example.com/forum/myboard"
},
"url": "https://janedeveloper.github.io/myboard/myboard-1.0.0.zip",
"archiveFileName": "myboard-1.0.0.zip",
"checksum": "SHA-256:ec3ff8a1dc96d3ba6f432b9b837a35fd4174a34b3d2927de1d51010e8b94f9f1",
"size": "15005",
"boards": [{ "name": "My Board" }, { "name": "My Board Pro" }],
"toolsDependencies": [
{
"packager": "arduino",
"name": "avr-gcc",
"version": "4.8.1-arduino5"
},
{
"packager": "arduino",
"name": "avrdude",
"version": "6.0.1-arduino5"
}
]
},
{
"name": "My Board",
"architecture": "mbed",
"version": "",
"category": "Contributed",
"help": {
"online": "http://example.com/forum/myboard"
},
"url": "https://janedeveloper.github.io/myboard/myboard-1.0.1.zip",
"archiveFileName": "myboard-1.0.1.zip",
"checksum": "SHA-256:9c86ee28a7ce9fe33e8b07ec643316131e0031b0d22e63bb398902a5fdadbca9",
"size": "15125",
"boards": [{ "name": "My Board" }, { "name": "My Board Pro" }],
"toolsDependencies": [
{
"packager": "arduino",
"name": "avr-gcc",
"version": "4.8.1-arduino5"
},
{
"packager": "arduino",
"name": "avrdude",
"version": "6.0.1-arduino5"
}
]
}
],
"tools": [
{
"name": "",
"version": "0.10.0-arduino1-static",
"systems": [
{
"host": "i386-apple-darwin11",
"url": "http://downloads.arduino.cc/arduino.org/OpenOCD-0.10.0-nrf52-osx-static.tar.gz",
"archiveFileName": "OpenOCD-0.10.0-nrf52-osx-static.tar.gz",
"size": "1529841",
"checksum": "SHA-256:46bd02c1d42c5d94c4936e4d4a0ff29697b621840be9a6f882e316203122049d"
},
{
"host": "x86_64-linux-gnu",
"url": "http://downloads.arduino.cc/arduino.org/OpenOCD-0.10.0-nrf52-linux64-static.tar.gz",
"archiveFileName": "OpenOCD-0.10.0-nrf52-linux64-static.tar.gz",
"size": "1777984",
"checksum": "SHA-256:1c9ae77930dd7377d8c13f84abe7307b67fdcd6da74cc1ce269a79e138e7a00a"
}
]
},
{
"name": "CMSIS",
"version": "",
"systems": [
{
"host": "arm-linux-gnueabihf",
"url": "http://example.com",
"archiveFileName": "CMSIS-4.0.0.tar.bz2",
"checksum": "SHA-256:7d637d2d7a0c6bacc22065848a201db2fff124268e4a56868260d0f472b4bbb7",
"size": "17642623"
},
{
"host": "i686-mingw32",
"url": "http://example.com",
"archiveFileName": "CMSIS-4.0.0.tar.bz2",
"checksum": "SHA-256:7d637d2d7a0c6bacc22065848a201db2fff124268e4a56868260d0f472b4bbb7",
"size": "17642623"
}
]
},
{
"name": "bossac",
"version": "1.9.1-arduino2",
"systems": [
{
"host": "",
"url": "http://downloads.arduino.cc/tools/bossac-1.9.1-arduino2-linuxaarch64.tar.gz",
"archiveFileName": "bossac-1.9.1-arduino2-linuxaarch64.tar.gz",
"checksum": "SHA-256:c167fa0ea223966f4d21f5592da3888bcbfbae385be6c5c4e41f8abff35f5cb1",
"size": "442853"
}
]
}
]
}
]
}