Merge pull request #199 from per1234/toolsdependencies-data

per1234 · web-flow · commit 9bdca8ba87ac · 2021-06-23T00:35:27.000-07:00
Provide object-level `packages[].platforms[].toolsDependencies[]` package index data to rules
diff --git a/internal/project/projectdata/packageindex.go b/internal/project/projectdata/packageindex.go
@@ -43,6 +43,7 @@ func InitializeForPackageIndex() {
 	packageIndexPackages = nil
 	packageIndexPlatforms = nil
 	packageIndexBoards = nil
+	packageIndexToolsDependencies = nil
 	packageIndexTools = nil
 	packageIndexSystems = nil
 	packageIndexSchemaValidationResult = nil
@@ -57,6 +58,10 @@ func InitializeForPackageIndex() {
 			packageIndexBoards = append(packageIndexBoards, getPackageIndexData(platformData.Object, platformData.JSONPointer, "boards", platformData.ID, " - {{index . 0}}", []string{"name"})...)
 		}
 
+		for _, platformData := range PackageIndexPlatforms() {
+			packageIndexToolsDependencies = append(packageIndexToolsDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "toolsDependencies", platformData.ID, " - {{index . 0}}:{{index . 1}}@{{index . 2}}", []string{"packager", "name", "version"})...)
+		}
+
 		for _, packageData := range PackageIndexPackages() {
 			packageIndexTools = append(packageIndexTools, getPackageIndexData(packageData.Object, packageData.JSONPointer, "tools", packageData.ID, ":{{index . 0}}@{{index . 1}}", []string{"name", "version"})...)
 		}
@@ -111,6 +116,13 @@ func PackageIndexBoards() []PackageIndexData {
 	return packageIndexBoards
 }
 
+var packageIndexToolsDependencies []PackageIndexData
+
+// PackageIndexToolsDependencies returns the slice of tool dependency data for the package index.
+func PackageIndexToolsDependencies() []PackageIndexData {
+	return packageIndexToolsDependencies
+}
+
 var packageIndexTools []PackageIndexData
 
 // PackageIndexTools returns the slice of tool data for the package index.
diff --git a/internal/project/projectdata/packageindex_test.go b/internal/project/projectdata/packageindex_test.go
@@ -47,6 +47,8 @@ func TestInitializeForPackageIndex(t *testing.T) {
 		packageIndexPlatformsDataAssertion          []PackageIndexData
 		packageIndexBoardsAssertion                 assert.ValueAssertionFunc
 		packageIndexBoardsDataAssertion             []PackageIndexData
+		packageIndexToolsDependenciesAssertion      assert.ValueAssertionFunc
+		packageIndexToolsDependenciesDataAssertion  []PackageIndexData
 		packageIndexToolsAssertion                  assert.ValueAssertionFunc
 		packageIndexToolsDataAssertion              []PackageIndexData
 		packageIndexSystemsAssertion                assert.ValueAssertionFunc
@@ -124,6 +126,41 @@ func TestInitializeForPackageIndex(t *testing.T) {
 					JSONPointer: "/packages/1/platforms/1/boards/1",
 				},
 			},
+			packageIndexToolsDependenciesAssertion: assert.NotNil,
+			packageIndexToolsDependenciesDataAssertion: []PackageIndexData{
+				{
+					ID:          "foopackager1:avr@1.0.0 - arduino:avr-gcc@4.8.1-arduino5",
+					JSONPointer: "/packages/0/platforms/0/toolsDependencies/0",
+				},
+				{
+					ID:          "foopackager1:avr@1.0.0 - arduino:avrdude@6.0.1-arduino5",
+					JSONPointer: "/packages/0/platforms/0/toolsDependencies/1",
+				},
+				{
+					ID:          "foopackager1:avr@1.0.1 - arduino:avr-gcc@7.3.0-atmel3.6.1-arduino7",
+					JSONPointer: "/packages/0/platforms/1/toolsDependencies/0",
+				},
+				{
+					ID:          "foopackager1:avr@1.0.1 - arduino:avrdude@6.3.0-arduino17",
+					JSONPointer: "/packages/0/platforms/1/toolsDependencies/1",
+				},
+				{
+					ID:          "foopackager2:samd@2.0.0 - arduino:arm-none-eabi-gcc@7-2017q4",
+					JSONPointer: "/packages/1/platforms/0/toolsDependencies/0",
+				},
+				{
+					ID:          "foopackager2:samd@2.0.0 - arduino:bossac@1.7.0-arduino3",
+					JSONPointer: "/packages/1/platforms/0/toolsDependencies/1",
+				},
+				{
+					ID:          "foopackager2:mbed@1.1.1 - arduino:openocd@0.11.0-arduino2",
+					JSONPointer: "/packages/1/platforms/1/toolsDependencies/0",
+				},
+				{
+					ID:          "foopackager2:mbed@1.1.1 - arduino:arm-none-eabi-gcc@7-2017q4",
+					JSONPointer: "/packages/1/platforms/1/toolsDependencies/1",
+				},
+			},
 			packageIndexToolsAssertion: assert.NotNil,
 			packageIndexToolsDataAssertion: []PackageIndexData{
 				{
@@ -239,6 +276,57 @@ func TestInitializeForPackageIndex(t *testing.T) {
 					JSONPointer: "/packages/1/platforms/2/boards/1",
 				},
 			},
+			packageIndexToolsDependenciesAssertion: assert.NotNil,
+			packageIndexToolsDependenciesDataAssertion: []PackageIndexData{
+				{
+					ID:          "/packages/0/platforms/0/toolsDependencies/0",
+					JSONPointer: "/packages/0/platforms/0/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/0/platforms/0/toolsDependencies/1",
+					JSONPointer: "/packages/0/platforms/0/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/0/platforms/1/toolsDependencies/0",
+					JSONPointer: "/packages/0/platforms/1/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/0/platforms/1/toolsDependencies/1",
+					JSONPointer: "/packages/0/platforms/1/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/0/toolsDependencies/0",
+					JSONPointer: "/packages/1/platforms/0/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/1/platforms/0/toolsDependencies/1",
+					JSONPointer: "/packages/1/platforms/0/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/1/toolsDependencies/0",
+					JSONPointer: "/packages/1/platforms/1/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/1/platforms/1/toolsDependencies/1",
+					JSONPointer: "/packages/1/platforms/1/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/2/toolsDependencies/0",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/1/platforms/2/toolsDependencies/1",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/2/toolsDependencies/2",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/2",
+				},
+				{
+					ID:          "foopackager2:megaavr@1.0.0 - arduino:CMSIS@4.5.0",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/3",
+				},
+			},
 			packageIndexToolsAssertion: assert.NotNil,
 			packageIndexToolsDataAssertion: []PackageIndexData{
 				{
@@ -362,6 +450,57 @@ func TestInitializeForPackageIndex(t *testing.T) {
 					JSONPointer: "/packages/1/platforms/2/boards/1",
 				},
 			},
+			packageIndexToolsDependenciesAssertion: assert.NotNil,
+			packageIndexToolsDependenciesDataAssertion: []PackageIndexData{
+				{
+					ID:          "/packages/0/platforms/0/toolsDependencies/0",
+					JSONPointer: "/packages/0/platforms/0/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/0/platforms/0/toolsDependencies/1",
+					JSONPointer: "/packages/0/platforms/0/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/0/platforms/1/toolsDependencies/0",
+					JSONPointer: "/packages/0/platforms/1/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/0/platforms/1/toolsDependencies/1",
+					JSONPointer: "/packages/0/platforms/1/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/0/toolsDependencies/0",
+					JSONPointer: "/packages/1/platforms/0/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/1/platforms/0/toolsDependencies/1",
+					JSONPointer: "/packages/1/platforms/0/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/1/toolsDependencies/0",
+					JSONPointer: "/packages/1/platforms/1/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/1/platforms/1/toolsDependencies/1",
+					JSONPointer: "/packages/1/platforms/1/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/2/toolsDependencies/0",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/0",
+				},
+				{
+					ID:          "/packages/1/platforms/2/toolsDependencies/1",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/1",
+				},
+				{
+					ID:          "/packages/1/platforms/2/toolsDependencies/2",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/2",
+				},
+				{
+					ID:          "foopackager2:megaavr@1.0.0 - arduino:CMSIS@4.5.0",
+					JSONPointer: "/packages/1/platforms/2/toolsDependencies/3",
+				},
+			},
 			packageIndexToolsAssertion: assert.NotNil,
 			packageIndexToolsDataAssertion: []PackageIndexData{
 				{
@@ -411,6 +550,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
 			packageIndexPackagesAssertion:               assert.Nil,
 			packageIndexPlatformsAssertion:              assert.Nil,
 			packageIndexBoardsAssertion:                 assert.Nil,
+			packageIndexToolsDependenciesAssertion:      assert.Nil,
 			packageIndexToolsAssertion:                  assert.Nil,
 			packageIndexSystemsAssertion:                assert.Nil,
 			packageIndexSchemaValidationResultAssertion: assert.Nil,
@@ -424,6 +564,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
 			packageIndexPackagesAssertion:               assert.Nil,
 			packageIndexPlatformsAssertion:              assert.Nil,
 			packageIndexBoardsAssertion:                 assert.Nil,
+			packageIndexToolsDependenciesAssertion:      assert.Nil,
 			packageIndexToolsAssertion:                  assert.Nil,
 			packageIndexSystemsAssertion:                assert.Nil,
 			packageIndexSchemaValidationResultAssertion: assert.Nil,
@@ -469,6 +610,14 @@ func TestInitializeForPackageIndex(t *testing.T) {
 			}
 		}
 
+		testTable.packageIndexToolsDependenciesAssertion(t, PackageIndexToolsDependencies(), testTable.testName)
+		if PackageIndexToolsDependencies() != nil {
+			for index, packageIndexToolsDependency := range PackageIndexToolsDependencies() {
+				assert.Equal(t, testTable.packageIndexToolsDependenciesDataAssertion[index].ID, packageIndexToolsDependency.ID, testTable.testName)
+				assert.Equal(t, testTable.packageIndexToolsDependenciesDataAssertion[index].JSONPointer, packageIndexToolsDependency.JSONPointer, testTable.testName)
+			}
+		}
+
 		testTable.packageIndexToolsAssertion(t, PackageIndexTools(), testTable.testName)
 		if PackageIndexTools() != nil {
 			for index, packageIndexTool := range PackageIndexTools() {
diff --git a/internal/project/projectdata/testdata/packageindexes/empty-ids/package_foo_index.json b/internal/project/projectdata/testdata/packageindexes/empty-ids/package_foo_index.json
@@ -52,12 +52,12 @@
             {
               "packager": "arduino",
               "name": "avr-gcc",
-              "version": "4.8.1-arduino5"
+              "version": "7.3.0-atmel3.6.1-arduino7"
             },
             {
               "packager": "arduino",
               "name": "avrdude",
-              "version": "6.0.1-arduino5"
+              "version": "6.3.0-arduino17"
             }
           ]
         }
@@ -89,13 +89,13 @@
           "toolsDependencies": [
             {
               "packager": "arduino",
-              "name": "avr-gcc",
-              "version": "4.8.1-arduino5"
+              "name": "arm-none-eabi-gcc",
+              "version": "7-2017q4"
             },
             {
               "packager": "arduino",
-              "name": "avrdude",
-              "version": "6.0.1-arduino5"
+              "name": "bossac",
+              "version": "1.7.0-arduino3"
             }
           ]
         },
@@ -115,13 +115,13 @@
           "toolsDependencies": [
             {
               "packager": "arduino",
-              "name": "avr-gcc",
-              "version": "4.8.1-arduino5"
+              "name": "openocd",
+              "version": "0.11.0-arduino2"
             },
             {
               "packager": "arduino",
-              "name": "avrdude",
-              "version": "6.0.1-arduino5"
+              "name": "arm-none-eabi-gcc",
+              "version": "7-2017q4"
             }
           ]
         },
@@ -140,14 +140,24 @@
           "boards": [{ "name": "" }, { "name": "My Board Pro" }],
           "toolsDependencies": [
             {
-              "packager": "arduino",
+              "packager": "",
               "name": "avr-gcc",
               "version": "4.8.1-arduino5"
             },
             {
               "packager": "arduino",
-              "name": "avrdude",
+              "name": "",
               "version": "6.0.1-arduino5"
+            },
+            {
+              "packager": "arduino",
+              "name": "openocd",
+              "version": ""
+            },
+            {
+              "packager": "arduino",
+              "name": "CMSIS",
+              "version": "4.5.0"
             }
           ]
         }
diff --git a/internal/project/projectdata/testdata/packageindexes/missing-ids/package_foo_index.json b/internal/project/projectdata/testdata/packageindexes/missing-ids/package_foo_index.json
@@ -51,12 +51,12 @@
             {
               "packager": "arduino",
               "name": "avr-gcc",
-              "version": "4.8.1-arduino5"
+              "version": "7.3.0-atmel3.6.1-arduino7"
             },
             {
               "packager": "arduino",
               "name": "avrdude",
-              "version": "6.0.1-arduino5"
+              "version": "6.3.0-arduino17"
             }
           ]
         }
@@ -87,13 +87,13 @@
           "toolsDependencies": [
             {
               "packager": "arduino",
-              "name": "avr-gcc",
-              "version": "4.8.1-arduino5"
+              "name": "arm-none-eabi-gcc",
+              "version": "7-2017q4"
             },
             {
               "packager": "arduino",
-              "name": "avrdude",
-              "version": "6.0.1-arduino5"
+              "name": "bossac",
+              "version": "1.7.0-arduino3"
             }
           ]
         },
@@ -112,13 +112,13 @@
           "toolsDependencies": [
             {
               "packager": "arduino",
-              "name": "avr-gcc",
-              "version": "4.8.1-arduino5"
+              "name": "openocd",
+              "version": "0.11.0-arduino2"
             },
             {
               "packager": "arduino",
-              "name": "avrdude",
-              "version": "6.0.1-arduino5"
+              "name": "arm-none-eabi-gcc",
+              "version": "7-2017q4"
             }
           ]
         },
@@ -137,14 +137,21 @@
           "boards": [{ "foo": "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"
+            },
+            {
+              "packager": "arduino",
+              "name": "openocd"
+            },
+            {
+              "packager": "arduino",
+              "name": "CMSIS",
+              "version": "4.5.0"
             }
           ]
         }
diff --git a/internal/project/projectdata/testdata/packageindexes/valid-package-index/package_foo_index.json b/internal/project/projectdata/testdata/packageindexes/valid-package-index/package_foo_index.json

Original file line number	Diff line number	Diff line change
`@@ -52,12 +52,12 @@`
`52`	`52`	`{`
`53`	`53`	`"packager": "arduino",`
`54`	`54`	`"name": "avr-gcc",`
`55`		`- "version": "4.8.1-arduino5"`
	`55`	`+ "version": "7.3.0-atmel3.6.1-arduino7"`
`56`	`56`	`},`
`57`	`57`	`{`
`58`	`58`	`"packager": "arduino",`
`59`	`59`	`"name": "avrdude",`
`60`		`- "version": "6.0.1-arduino5"`
	`60`	`+ "version": "6.3.0-arduino17"`
`61`	`61`	`}`
`62`	`62`	`]`
`63`	`63`	`}`
`@@ -89,13 +89,13 @@`
`89`	`89`	`"toolsDependencies": [`
`90`	`90`	`{`
`91`	`91`	`"packager": "arduino",`
`92`		`- "name": "avr-gcc",`
`93`		`- "version": "4.8.1-arduino5"`
	`92`	`+ "name": "arm-none-eabi-gcc",`
	`93`	`+ "version": "7-2017q4"`
`94`	`94`	`},`
`95`	`95`	`{`
`96`	`96`	`"packager": "arduino",`
`97`		`- "name": "avrdude",`
`98`		`- "version": "6.0.1-arduino5"`
	`97`	`+ "name": "bossac",`
	`98`	`+ "version": "1.7.0-arduino3"`
`99`	`99`	`}`
`100`	`100`	`]`
`101`	`101`	`},`
`@@ -115,13 +115,13 @@`
`115`	`115`	`"toolsDependencies": [`
`116`	`116`	`{`
`117`	`117`	`"packager": "arduino",`
`118`		`- "name": "avr-gcc",`
`119`		`- "version": "4.8.1-arduino5"`
	`118`	`+ "name": "openocd",`
	`119`	`+ "version": "0.11.0-arduino2"`
`120`	`120`	`},`
`121`	`121`	`{`
`122`	`122`	`"packager": "arduino",`
`123`		`- "name": "avrdude",`
`124`		`- "version": "6.0.1-arduino5"`
	`123`	`+ "name": "arm-none-eabi-gcc",`
	`124`	`+ "version": "7-2017q4"`
`125`	`125`	`}`
`126`	`126`	`]`
`127`	`127`	`},`
`@@ -140,14 +140,24 @@`
`140`	`140`	`"boards": [{ "name": "" }, { "name": "My Board Pro" }],`
`141`	`141`	`"toolsDependencies": [`
`142`	`142`	`{`
`143`		`- "packager": "arduino",`
	`143`	`+ "packager": "",`
`144`	`144`	`"name": "avr-gcc",`
`145`	`145`	`"version": "4.8.1-arduino5"`
`146`	`146`	`},`
`147`	`147`	`{`
`148`	`148`	`"packager": "arduino",`
`149`		`- "name": "avrdude",`
	`149`	`+ "name": "",`
`150`	`150`	`"version": "6.0.1-arduino5"`
	`151`	`+ },`
	`152`	`+ {`
	`153`	`+ "packager": "arduino",`
	`154`	`+ "name": "openocd",`
	`155`	`+ "version": ""`
	`156`	`+ },`
	`157`	`+ {`
	`158`	`+ "packager": "arduino",`
	`159`	`+ "name": "CMSIS",`
	`160`	`+ "version": "4.5.0"`
`151`	`161`	`}`
`152`	`162`	`]`
`153`	`163`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,12 +51,12 @@`
`51`	`51`	`{`
`52`	`52`	`"packager": "arduino",`
`53`	`53`	`"name": "avr-gcc",`
`54`		`- "version": "4.8.1-arduino5"`
	`54`	`+ "version": "7.3.0-atmel3.6.1-arduino7"`
`55`	`55`	`},`
`56`	`56`	`{`
`57`	`57`	`"packager": "arduino",`
`58`	`58`	`"name": "avrdude",`
`59`		`- "version": "6.0.1-arduino5"`
	`59`	`+ "version": "6.3.0-arduino17"`
`60`	`60`	`}`
`61`	`61`	`]`
`62`	`62`	`}`
`@@ -87,13 +87,13 @@`
`87`	`87`	`"toolsDependencies": [`
`88`	`88`	`{`
`89`	`89`	`"packager": "arduino",`
`90`		`- "name": "avr-gcc",`
`91`		`- "version": "4.8.1-arduino5"`
	`90`	`+ "name": "arm-none-eabi-gcc",`
	`91`	`+ "version": "7-2017q4"`
`92`	`92`	`},`
`93`	`93`	`{`
`94`	`94`	`"packager": "arduino",`
`95`		`- "name": "avrdude",`
`96`		`- "version": "6.0.1-arduino5"`
	`95`	`+ "name": "bossac",`
	`96`	`+ "version": "1.7.0-arduino3"`
`97`	`97`	`}`
`98`	`98`	`]`
`99`	`99`	`},`
`@@ -112,13 +112,13 @@`
`112`	`112`	`"toolsDependencies": [`
`113`	`113`	`{`
`114`	`114`	`"packager": "arduino",`
`115`		`- "name": "avr-gcc",`
`116`		`- "version": "4.8.1-arduino5"`
	`115`	`+ "name": "openocd",`
	`116`	`+ "version": "0.11.0-arduino2"`
`117`	`117`	`},`
`118`	`118`	`{`
`119`	`119`	`"packager": "arduino",`
`120`		`- "name": "avrdude",`
`121`		`- "version": "6.0.1-arduino5"`
	`120`	`+ "name": "arm-none-eabi-gcc",`
	`121`	`+ "version": "7-2017q4"`
`122`	`122`	`}`
`123`	`123`	`]`
`124`	`124`	`},`
`@@ -137,14 +137,21 @@`
`137`	`137`	`"boards": [{ "foo": "My Board" }, { "name": "My Board Pro" }],`
`138`	`138`	`"toolsDependencies": [`
`139`	`139`	`{`
`140`		`- "packager": "arduino",`
`141`	`140`	`"name": "avr-gcc",`
`142`	`141`	`"version": "4.8.1-arduino5"`
`143`	`142`	`},`
`144`	`143`	`{`
`145`	`144`	`"packager": "arduino",`
`146`		`- "name": "avrdude",`
`147`	`145`	`"version": "6.0.1-arduino5"`
	`146`	`+ },`
	`147`	`+ {`
	`148`	`+ "packager": "arduino",`
	`149`	`+ "name": "openocd"`
	`150`	`+ },`
	`151`	`+ {`
	`152`	`+ "packager": "arduino",`
	`153`	`+ "name": "CMSIS",`
	`154`	`+ "version": "4.5.0"`
`148`	`155`	`}`
`149`	`156`	`]`
`150`	`157`	`}`