Added parsing of monitorDependecies field in package index

Author: cmaglie

arduino/cores/cores.go

@@ -51,6 +51,7 @@ type PlatformRelease struct {
 	BoardsManifest          []*BoardManifest
 	ToolDependencies        ToolDependencies
 	DiscoveryDependencies   DiscoveryDependencies
+	MonitorDependencies     MonitorDependencies
 	Help                    PlatformReleaseHelp    `json:"-"`
 	Platform                *Platform              `json:"-"`
 	Properties              *properties.Map        `json:"-"`
@@ -142,6 +143,30 @@ func (d *DiscoveryDependency) String() string {
 	return fmt.Sprintf("%s:%s", d.Packager, d.Name)
 }
 
+// MonitorDependencies is a list of MonitorDependency
+type MonitorDependencies []*MonitorDependency
+
+// Sort the DiscoveryDependencies by name.
+func (d MonitorDependencies) Sort() {
+	sort.Slice(d, func(i, j int) bool {
+		if d[i].Packager != d[j].Packager {
+			return d[i].Packager < d[j].Packager
+		}
+		return d[i].Name < d[j].Name
+	})
+}
+
+// MonitorDependency identifies a specific monitor, version is omitted
+// since the latest version will always be used
+type MonitorDependency struct {
+	Name     string
+	Packager string
+}
+
+func (d *MonitorDependency) String() string {
+	return fmt.Sprintf("%s:%s", d.Packager, d.Name)
+}
+
 // GetOrCreateRelease returns the specified release corresponding the provided version,
 // or creates a new one if not found.
 func (platform *Platform) GetOrCreateRelease(version *semver.Version) *PlatformRelease {

arduino/cores/packageindex/index.go

@@ -61,6 +61,7 @@ type indexPlatformRelease struct {
 	Help                  indexHelp                  `json:"help,omitempty"`
 	ToolDependencies      []indexToolDependency      `json:"toolsDependencies"`
 	DiscoveryDependencies []indexDiscoveryDependency `json:"discoveryDependencies"`
+	MonitorDependencies   []indexMonitorDependency   `json:"monitorDependencies"`
 }
 
 // indexToolDependency represents a single dependency of a core from a tool.
@@ -76,6 +77,12 @@ type indexDiscoveryDependency struct {
 	Name     string `json:"name"`
 }
 
+// indexMonitorDependency represents a single dependency of a core from a pluggable monitor tool.
+type indexMonitorDependency struct {
+	Packager string `json:"packager"`
+	Name     string `json:"name"`
+}
+
 // indexToolRelease represents a single Tool from package_index.json file.
 type indexToolRelease struct {
 	Name    string                    `json:"name,required"`
@@ -152,6 +159,14 @@ func IndexFromPlatformRelease(pr *cores.PlatformRelease) Index {
 		})
 	}
 
+	monitors := []indexMonitorDependency{}
+	for _, m := range pr.MonitorDependencies {
+		monitors = append(monitors, indexMonitorDependency{
+			Packager: m.Packager,
+			Name:     m.Name,
+		})
+	}
+
 	packageTools := []*indexToolRelease{}
 	for name, tool := range pr.Platform.Package.Tools {
 		for _, toolRelease := range tool.Releases {
@@ -196,6 +211,7 @@ func IndexFromPlatformRelease(pr *cores.PlatformRelease) Index {
 					Help:                  indexHelp{Online: pr.Help.Online},
 					ToolDependencies:      tools,
 					DiscoveryDependencies: discoveries,
+					MonitorDependencies:   monitors,
 				}},
 				Tools: packageTools,
 				Help:  indexHelp{Online: pr.Platform.Package.Help.Online},
@@ -251,6 +267,7 @@ func (inPlatformRelease indexPlatformRelease) extractPlatformIn(outPackage *core
 	outPlatformRelease.BoardsManifest = inPlatformRelease.extractBoardsManifest()
 	outPlatformRelease.ToolDependencies = inPlatformRelease.extractToolDependencies()
 	outPlatformRelease.DiscoveryDependencies = inPlatformRelease.extractDiscoveryDependencies()
+	outPlatformRelease.MonitorDependencies = inPlatformRelease.extractMonitorDependencies()
 	return nil
 }
 
@@ -277,6 +294,17 @@ func (inPlatformRelease indexPlatformRelease) extractDiscoveryDependencies() cor
 	return res
 }
 
+func (inPlatformRelease indexPlatformRelease) extractMonitorDependencies() cores.MonitorDependencies {
+	res := make(cores.MonitorDependencies, len(inPlatformRelease.MonitorDependencies))
+	for i, discovery := range inPlatformRelease.MonitorDependencies {
+		res[i] = &cores.MonitorDependency{
+			Name:     discovery.Name,
+			Packager: discovery.Packager,
+		}
+	}
+	return res
+}
+
 func (inPlatformRelease indexPlatformRelease) extractBoardsManifest() []*cores.BoardManifest {
 	boards := make([]*cores.BoardManifest, len(inPlatformRelease.Boards))
 	for i, board := range inPlatformRelease.Boards {

arduino/cores/packageindex/index_test.go

@@ -81,6 +81,16 @@ func TestIndexFromPlatformRelease(t *testing.T) {
 				Name:     "serial-discovery",
 			},
 		},
+		MonitorDependencies: cores.MonitorDependencies{
+			{
+				Packager: "arduino",
+				Name:     "ble-monitor",
+			},
+			{
+				Packager: "arduino",
+				Name:     "serial-monitor",
+			},
+		},
 		Platform: &cores.Platform{
 			Name:         "Arduino AVR Boards",
 			Architecture: "avr",
@@ -355,6 +365,16 @@ func TestIndexFromPlatformRelease(t *testing.T) {
 						Name:     "serial-discovery",
 					},
 				},
+				MonitorDependencies: []indexMonitorDependency{
+					{
+						Packager: "arduino",
+						Name:     "ble-monitor",
+					},
+					{
+						Packager: "arduino",
+						Name:     "serial-monitor",
+					},
+				},
 			}},
 			Tools: []*indexToolRelease{
 				{
@@ -552,6 +572,7 @@ func TestIndexFromPlatformRelease(t *testing.T) {
 			require.ElementsMatch(t, expectedPlatform.Boards, indexPlatform.Boards)
 			require.ElementsMatch(t, expectedPlatform.ToolDependencies, indexPlatform.ToolDependencies)
 			require.ElementsMatch(t, expectedPlatform.DiscoveryDependencies, indexPlatform.DiscoveryDependencies)
+			require.ElementsMatch(t, expectedPlatform.MonitorDependencies, indexPlatform.MonitorDependencies)
 		}
 	}
 }

i18n/data/en.po

@@ -2394,6 +2394,7 @@ msgstr "boardname"
 #: arduino/discovery/discovery.go:361
 #: arduino/discovery/discovery.go:384
 #: arduino/discovery/discovery.go:407
+#: arduino/monitor/monitor.go:246
 msgid "calling %[1]s: %[2]w"
 msgstr "calling %[1]s: %[2]w"
 
@@ -2445,17 +2446,39 @@ msgstr "command"
 #: arduino/discovery/discovery.go:365
 #: arduino/discovery/discovery.go:388
 #: arduino/discovery/discovery.go:411
+#: arduino/monitor/monitor.go:250
+#: arduino/monitor/monitor.go:270
+#: arduino/monitor/monitor.go:287
+#: arduino/monitor/monitor.go:323
+#: arduino/monitor/monitor.go:351
 msgid "command failed: %s"
 msgstr "command failed: %s"
 
+#: arduino/monitor/monitor.go:349
+msgid "communication out of sync, expected 'close', received '%s'"
+msgstr "communication out of sync, expected 'close', received '%s'"
+
+#: arduino/monitor/monitor.go:285
+msgid "communication out of sync, expected 'configure', received '%s'"
+msgstr "communication out of sync, expected 'configure', received '%s'"
+
+#: arduino/monitor/monitor.go:268
+msgid "communication out of sync, expected 'describe', received '%s'"
+msgstr "communication out of sync, expected 'describe', received '%s'"
+
 #: arduino/discovery/discovery.go:299
+#: arduino/monitor/monitor.go:248
 msgid "communication out of sync, expected 'hello', received '%s'"
 msgstr "communication out of sync, expected 'hello', received '%s'"
 
 #: arduino/discovery/discovery.go:386
 msgid "communication out of sync, expected 'list', received '%s'"
 msgstr "communication out of sync, expected 'list', received '%s'"
 
+#: arduino/monitor/monitor.go:321
+msgid "communication out of sync, expected 'open', received '%s'"
+msgstr "communication out of sync, expected 'open', received '%s'"
+
 #: arduino/discovery/discovery.go:363
 msgid "communication out of sync, expected 'quit', received '%s'"
 msgstr "communication out of sync, expected 'quit', received '%s'"
@@ -2771,7 +2794,7 @@ msgstr "invalid path creating config dir: %[1]s error: %[2]w"
 msgid "invalid path writing inventory file: %[1]s error: %[2]w"
 msgstr "invalid path writing inventory file: %[1]s error: %[2]w"
 
-#: arduino/cores/packageindex/index.go:239
+#: arduino/cores/packageindex/index.go:255
 msgid "invalid platform archive size: %s"
 msgstr "invalid platform archive size: %s"
 
@@ -3022,6 +3045,7 @@ msgid "port not found: %[1]s %[2]s"
 msgstr "port not found: %[1]s %[2]s"
 
 #: arduino/discovery/discovery.go:303
+#: arduino/monitor/monitor.go:252
 msgid "protocol version not supported: requested 1, got %d"
 msgstr "protocol version not supported: requested 1, got %d"
 
@@ -3206,6 +3230,10 @@ msgstr "the server responded with status %s"
 msgid "timeout waiting for message from %s"
 msgstr "timeout waiting for message from %s"
 
+#: arduino/monitor/monitor.go:177
+msgid "timeout waiting for message from monitor %s"
+msgstr "timeout waiting for message from monitor %s"
+
 #: arduino/cores/packagemanager/install_uninstall.go:165
 msgid "tool %s is not managed by package manager"
 msgstr "tool %s is not managed by package manager"