enbility / eebus-go / 26031653122

95%

push

github

SHIP Pairing Service Integration (#212)

# SHIP Pairing Service Integration

This PR introduces breaking API changes to accommodate the latest
ship-go module updates, featuring the integration of the new SHIP
Pairing Service.

## Core changes:
- Service Start() now returns an error when connection hub returns a
runtime error
- ServiceIdentity is now used instead of 'SKI' only. Subsequently, All
APIs dependent on ski have been migrated to a new 'identity' parameter.
For example, `RegisterRemoteSKI(ski, shipID string)` is migrated to
`RegisterRemoteService(identity shipapi.ServiceIdentity)`
- New Service APIs:
```go
GetLocalCertificateFingerprint() (string, error)
StartAnnouncementTo(target shipapi.PairingTarget) error
StopAnnouncementTo(shipID string) error
IsAnnouncingTo(shipID string) bool
GetActiveAnnouncements() []string
HasTrustedAddCuDevice() (string, string)
```
- New Service events:
```go
ServiceAutoTrusted(service ServiceInterface, identity shipapi.ServiceIdentity)
ServiceAutoTrustFailed(service ServiceInterface, identity shipapi.ServiceIdentity, reason error)
ServiceAutoTrustRemoved(service ServiceInterface, identity shipapi.ServiceIdentity, reason string)
```
- Service Configuration: New parameters:
`pairingConfig`: Optional SHIP Pairing configuration. Pass nil if SHIP
Pairing should not be used.
`ringBufferPersistence`: Interface to Pairing ring buffer persistence.
SHALL be set if pairingConfig is set to listener mode (i.e. devA). See
ship-go examples on how to create an implementation of this interface.

## Examples:

The examples have been updated to accommodate the new API changes.
In addition to that, the legacy commandline arguments have been retired
and replaced by flags instead.

86 of 92 new or added lines in 4 files covered. (93.48%)

7082 of 7432 relevant lines covered (95.29%)

12.4 hits per line