Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 195a9f7a9f | |||
| ecbf4d447c | |||
| 438d422b53 | |||
| 38eb2cc352 | |||
| 1754eb6e84 | |||
| 906d005edf | |||
| b12e8df35b |
@@ -11,6 +11,11 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.ref, 'refs/tags/v') # Only run on tag push
|
||||
steps:
|
||||
- name: Set up Go Environment
|
||||
uses: actions/setup-go@v4
|
||||
with:
|
||||
go-version: '1.25'
|
||||
|
||||
- name: Run Go List
|
||||
continue-on-error: true
|
||||
env:
|
||||
|
||||
29
CHANGELOG.md
Normal file
29
CHANGELOG.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## v0.2.1 - 2026-01-05
|
||||
### Changed
|
||||
- Minor LSP improvements to tests
|
||||
- Refactor entire project edgeos -> toughswitch
|
||||
|
||||
## [v0.2.0] - 2026-01-04
|
||||
### Added
|
||||
- Thread-safe `Add` and `Del` methods to `Client` for dynamic host management.
|
||||
- `RWMutex` to `Client` struct to protect `devices` map.
|
||||
- `Transport` field to `Config` to allow mocking HTTP transport in tests.
|
||||
- `getDeviceByHost` helper to centralize device lookup locking.
|
||||
- Tests for thread safety and Add/Del functionality.
|
||||
|
||||
### Changed
|
||||
- Refactored `GetAll*` methods to snapshot host keys before iteration to avoid concurrent map read/write panic.
|
||||
- Improved concurrent `GetAll` operations.
|
||||
|
||||
## [v0.1.1] - 2026-01-04
|
||||
### Fixed
|
||||
- CI pipeline configuration.
|
||||
|
||||
## [v0.1.0] - 2026-01-04
|
||||
### Added
|
||||
- Initial CI pipeline setup.
|
||||
- Initial release of Ubiquiti toughswitch Go Client.
|
||||
17
README.md
17
README.md
@@ -1,6 +1,7 @@
|
||||
# edgeos
|
||||
# toughswitch
|
||||
|
||||
A Go client library for interacting with Ubiquiti EdgeOS devices (specifically tested with EdgeSwitch XP / ToughSwitch) via their internal REST API.
|
||||
A Go client library for interacting with Ubiquiti toughswitch devices (specifically tested with
|
||||
ToughSwitch POE Pro (TS-8-PRO)) via their internal REST API.
|
||||
|
||||
**⚠️ Disclaimer: This library is based on reverse-engineered API calls. It is not an official Ubiquiti product and is subject to change if the device firmware changes.**
|
||||
|
||||
@@ -19,7 +20,7 @@ A Go client library for interacting with Ubiquiti EdgeOS devices (specifically t
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get gitea.libretechconsulting.com/rmcguire/edgeos-client/pkg/edgeos
|
||||
go get gitea.libretechconsulting.com/rmcguire/toughswitch-client/pkg/toughswitch
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -35,14 +36,14 @@ import (
|
||||
"log"
|
||||
"time"
|
||||
|
||||
"gitea.libretechconsulting.com/rmcguire/edgeos-client/pkg/edgeos"
|
||||
"gitea.libretechconsulting.com/rmcguire/toughswitch-client/pkg/toughswitch"
|
||||
)
|
||||
|
||||
func main() {
|
||||
ctx := context.Background()
|
||||
|
||||
// Configure your device(s)
|
||||
configs := []edgeos.Config{
|
||||
configs := []toughswitch.Config{
|
||||
{
|
||||
Host: "192.168.1.1",
|
||||
Username: "ubnt",
|
||||
@@ -53,7 +54,7 @@ func main() {
|
||||
}
|
||||
|
||||
// Initialize the client
|
||||
client := edgeos.MustNew(ctx, configs)
|
||||
client := toughswitch.MustNew(ctx, configs)
|
||||
|
||||
// Fetch system information
|
||||
deviceHost := "192.168.1.1"
|
||||
@@ -108,11 +109,11 @@ for _, stat := range stats {
|
||||
The client is designed to handle multiple devices concurrently.
|
||||
|
||||
```go
|
||||
configs := []edgeos.Config{
|
||||
configs := []toughswitch.Config{
|
||||
{Host: "192.168.1.1", ...},
|
||||
{Host: "192.168.1.2", ...},
|
||||
}
|
||||
client := edgeos.MustNew(ctx, configs)
|
||||
client := toughswitch.MustNew(ctx, configs)
|
||||
|
||||
// Get info for all configured devices in parallel
|
||||
allSystems, err := client.GetAllSystems(ctx)
|
||||
|
||||
2
go.mod
2
go.mod
@@ -1,3 +1,3 @@
|
||||
module gitea.libretechconsulting.com/rmcguire/edgeos-client
|
||||
module gitea.libretechconsulting.com/rmcguire/toughswitch-client
|
||||
|
||||
go 1.25.5
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
package edgeos
|
||||
|
||||
import "time"
|
||||
|
||||
// Config represents the configuration for an EdgeOS device.
|
||||
type Config struct {
|
||||
Host string
|
||||
Scheme string
|
||||
Insecure bool
|
||||
Username string
|
||||
Password string
|
||||
Timeout time.Duration
|
||||
}
|
||||
@@ -1,16 +1,16 @@
|
||||
package edgeos
|
||||
package toughswitch
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"errors"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// GetInterfaces retrieves the interfaces for a specific device.
|
||||
func (c *Client) GetInterfaces(ctx context.Context, host string) ([]Interface, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out []Interface
|
||||
@@ -24,43 +24,42 @@ func (c *Client) GetInterfaces(ctx context.Context, host string) ([]Interface, e
|
||||
// GetAllInterfaces retrieves interfaces for all devices.
|
||||
func (c *Client) GetAllInterfaces(ctx context.Context) (map[string][]Interface, error) {
|
||||
results := make(map[string][]Interface)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
// Use a buffered channel or just loop?
|
||||
// Since we return error if any fails? Or partial results?
|
||||
// Usually partial results + error or composite error.
|
||||
// I will return partial results and the last error for now, or just stop on error?
|
||||
// "methods to get ... for either all device"
|
||||
// I will implement parallel fetch.
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetInterfaces(ctx, h)
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetInterfaces(ctx, host)
|
||||
if err != nil {
|
||||
// For now, log error or ignore?
|
||||
// We should probably return an error map or just return what we have?
|
||||
// I will just skip failed ones for this implementation or log?
|
||||
// I'll return what succeeds.
|
||||
// The prompt doesn't specify error handling strategy for "all".
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
|
||||
// GetDevice retrieves the device info for a specific device.
|
||||
func (c *Client) GetDevice(ctx context.Context, host string) (*Device, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out Device
|
||||
@@ -74,31 +73,42 @@ func (c *Client) GetDevice(ctx context.Context, host string) (*Device, error) {
|
||||
// GetAllDevices retrieves device info for all devices.
|
||||
func (c *Client) GetAllDevices(ctx context.Context) (map[string]*Device, error) {
|
||||
results := make(map[string]*Device)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetDevice(ctx, h)
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetDevice(ctx, host)
|
||||
if err != nil {
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
|
||||
// GetSystem retrieves the system info for a specific device.
|
||||
func (c *Client) GetSystem(ctx context.Context, host string) (*System, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out System
|
||||
@@ -112,31 +122,42 @@ func (c *Client) GetSystem(ctx context.Context, host string) (*System, error) {
|
||||
// GetAllSystems retrieves system info for all devices.
|
||||
func (c *Client) GetAllSystems(ctx context.Context) (map[string]*System, error) {
|
||||
results := make(map[string]*System)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetSystem(ctx, h)
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetSystem(ctx, host)
|
||||
if err != nil {
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
|
||||
// GetVLANs retrieves the VLANs for a specific device.
|
||||
func (c *Client) GetVLANs(ctx context.Context, host string) (*VLANs, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out VLANs
|
||||
@@ -150,31 +171,42 @@ func (c *Client) GetVLANs(ctx context.Context, host string) (*VLANs, error) {
|
||||
// GetAllVLANs retrieves VLANs for all devices.
|
||||
func (c *Client) GetAllVLANs(ctx context.Context) (map[string]*VLANs, error) {
|
||||
results := make(map[string]*VLANs)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetVLANs(ctx, h)
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetVLANs(ctx, host)
|
||||
if err != nil {
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
|
||||
// GetServices retrieves the services for a specific device.
|
||||
func (c *Client) GetServices(ctx context.Context, host string) (*Services, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out Services
|
||||
@@ -188,31 +220,42 @@ func (c *Client) GetServices(ctx context.Context, host string) (*Services, error
|
||||
// GetAllServices retrieves services for all devices.
|
||||
func (c *Client) GetAllServices(ctx context.Context) (map[string]*Services, error) {
|
||||
results := make(map[string]*Services)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetServices(ctx, h)
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetServices(ctx, host)
|
||||
if err != nil {
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
|
||||
// GetStatistics retrieves the statistics for a specific device.
|
||||
func (c *Client) GetStatistics(ctx context.Context, host string) ([]Statistics, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out []Statistics
|
||||
@@ -226,31 +269,42 @@ func (c *Client) GetStatistics(ctx context.Context, host string) ([]Statistics,
|
||||
// GetAllStatistics retrieves statistics for all devices.
|
||||
func (c *Client) GetAllStatistics(ctx context.Context) (map[string][]Statistics, error) {
|
||||
results := make(map[string][]Statistics)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetStatistics(ctx, h)
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetStatistics(ctx, host)
|
||||
if err != nil {
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
|
||||
// GetNeighbors retrieves the neighbors for a specific device.
|
||||
func (c *Client) GetNeighbors(ctx context.Context, host string) ([]Neighbor, error) {
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
d, err := c.getDeviceByHost(host)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out []Neighbor
|
||||
@@ -264,22 +318,33 @@ func (c *Client) GetNeighbors(ctx context.Context, host string) ([]Neighbor, err
|
||||
// GetAllNeighbors retrieves neighbors for all devices.
|
||||
func (c *Client) GetAllNeighbors(ctx context.Context) (map[string][]Neighbor, error) {
|
||||
results := make(map[string][]Neighbor)
|
||||
var mu sync.Mutex
|
||||
var wg sync.WaitGroup
|
||||
var (
|
||||
mu sync.Mutex
|
||||
wg sync.WaitGroup
|
||||
errs error
|
||||
)
|
||||
|
||||
for host := range c.devices {
|
||||
wg.Add(1)
|
||||
go func(h string) {
|
||||
defer wg.Done()
|
||||
res, err := c.GetNeighbors(ctx, h)
|
||||
c.mu.RLock()
|
||||
hosts := make([]string, 0, len(c.devices))
|
||||
for h := range c.devices {
|
||||
hosts = append(hosts, h)
|
||||
}
|
||||
c.mu.RUnlock()
|
||||
|
||||
for _, host := range hosts {
|
||||
wg.Go(func() {
|
||||
res, err := c.GetNeighbors(ctx, host)
|
||||
if err != nil {
|
||||
mu.Lock()
|
||||
errs = errors.Join(errs, err)
|
||||
mu.Unlock()
|
||||
return
|
||||
}
|
||||
mu.Lock()
|
||||
results[h] = res
|
||||
results[host] = res
|
||||
mu.Unlock()
|
||||
}(host)
|
||||
})
|
||||
}
|
||||
wg.Wait()
|
||||
return results, nil
|
||||
return results, errs
|
||||
}
|
||||
@@ -1,10 +1,10 @@
|
||||
/*
|
||||
Package edgeos provides a client for interacting with Ubiquiti EdgeOS devices
|
||||
Package toughswitch provides a client for interacting with Ubiquiti toughswitch devices
|
||||
via their REST API. It supports authentication, token management, and
|
||||
retrieval of system, interface, VLAN, and discovery information from
|
||||
one or more devices.
|
||||
*/
|
||||
package edgeos
|
||||
package toughswitch
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
@@ -19,8 +19,9 @@ import (
|
||||
"sync"
|
||||
)
|
||||
|
||||
// Client handles communication with EdgeOS devices.
|
||||
// Client handles communication with toughswitch devices.
|
||||
type Client struct {
|
||||
mu sync.RWMutex
|
||||
devices map[string]*deviceClient
|
||||
}
|
||||
|
||||
@@ -31,33 +32,42 @@ type deviceClient struct {
|
||||
mu sync.Mutex
|
||||
}
|
||||
|
||||
// MustNew creates a new Client with the given configurations.
|
||||
// It panics if a configuration is invalid (though currently we just accept all).
|
||||
func MustNew(ctx context.Context, configs []Config) *Client {
|
||||
devices := make(map[string]*deviceClient)
|
||||
|
||||
for _, cfg := range configs {
|
||||
// Use Host as the key.
|
||||
func newDeviceClient(cfg Config) *deviceClient {
|
||||
// Ensure scheme is set
|
||||
if cfg.Scheme == "" {
|
||||
cfg.Scheme = "https"
|
||||
}
|
||||
|
||||
tr := http.DefaultTransport.(*http.Transport).Clone()
|
||||
if tr.TLSClientConfig == nil {
|
||||
tr.TLSClientConfig = &tls.Config{}
|
||||
var tr http.RoundTripper
|
||||
if cfg.Transport != nil {
|
||||
tr = cfg.Transport
|
||||
} else {
|
||||
defaultTr := http.DefaultTransport.(*http.Transport).Clone()
|
||||
if defaultTr.TLSClientConfig == nil {
|
||||
defaultTr.TLSClientConfig = &tls.Config{}
|
||||
}
|
||||
defaultTr.TLSClientConfig.InsecureSkipVerify = cfg.Insecure
|
||||
tr = defaultTr
|
||||
}
|
||||
tr.TLSClientConfig.InsecureSkipVerify = cfg.Insecure
|
||||
|
||||
client := &http.Client{
|
||||
Transport: tr,
|
||||
Timeout: cfg.Timeout,
|
||||
}
|
||||
|
||||
devices[cfg.Host] = &deviceClient{
|
||||
return &deviceClient{
|
||||
config: cfg,
|
||||
client: client,
|
||||
}
|
||||
}
|
||||
|
||||
// MustNew creates a new Client with the given configurations.
|
||||
// It panics if a configuration is invalid (though currently we just accept all).
|
||||
func MustNew(ctx context.Context, configs []Config) *Client {
|
||||
devices := make(map[string]*deviceClient)
|
||||
|
||||
for _, cfg := range configs {
|
||||
devices[cfg.Host] = newDeviceClient(cfg)
|
||||
}
|
||||
|
||||
return &Client{
|
||||
@@ -65,6 +75,51 @@ func MustNew(ctx context.Context, configs []Config) *Client {
|
||||
}
|
||||
}
|
||||
|
||||
// Add adds a new device to the client.
|
||||
// It returns an error if a device with the same host already exists.
|
||||
func (c *Client) Add(cfg *Config) error {
|
||||
if cfg == nil {
|
||||
return fmt.Errorf("config cannot be nil")
|
||||
}
|
||||
|
||||
d := newDeviceClient(*cfg)
|
||||
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
if _, ok := c.devices[cfg.Host]; ok {
|
||||
return fmt.Errorf("device already exists: %s", cfg.Host)
|
||||
}
|
||||
|
||||
c.devices[cfg.Host] = d
|
||||
return nil
|
||||
}
|
||||
|
||||
// Del removes a device from the client.
|
||||
// It returns an error if the device does not exist.
|
||||
func (c *Client) Del(host string) error {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
if _, ok := c.devices[host]; !ok {
|
||||
return fmt.Errorf("device not found: %s", host)
|
||||
}
|
||||
|
||||
delete(c.devices, host)
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Client) getDeviceByHost(host string) (*deviceClient, error) {
|
||||
c.mu.RLock()
|
||||
defer c.mu.RUnlock()
|
||||
|
||||
d, ok := c.devices[host]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("device not found: %s", host)
|
||||
}
|
||||
return d, nil
|
||||
}
|
||||
|
||||
func (d *deviceClient) login(ctx context.Context) error {
|
||||
d.mu.Lock()
|
||||
defer d.mu.Unlock()
|
||||
105
pkg/toughswitch/client_test.go
Normal file
105
pkg/toughswitch/client_test.go
Normal file
@@ -0,0 +1,105 @@
|
||||
package toughswitch
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"sync"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type mockTransport struct {
|
||||
RoundTripFunc func(req *http.Request) (*http.Response, error)
|
||||
}
|
||||
|
||||
func (m *mockTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
if m.RoundTripFunc != nil {
|
||||
return m.RoundTripFunc(req)
|
||||
}
|
||||
// Default mock response
|
||||
return &http.Response{
|
||||
StatusCode: 200,
|
||||
Body: io.NopCloser(bytes.NewBufferString("{}")),
|
||||
Header: make(http.Header),
|
||||
}, nil
|
||||
}
|
||||
|
||||
func TestClient_ThreadSafety(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
client := MustNew(ctx, []Config{})
|
||||
|
||||
var wg sync.WaitGroup
|
||||
start := make(chan struct{})
|
||||
|
||||
// Writer: Adds and deletes hosts
|
||||
wg.Go(func() {
|
||||
<-start
|
||||
for i := range 100 {
|
||||
host := fmt.Sprintf("host-%d", i)
|
||||
cfg := &Config{
|
||||
Host: host,
|
||||
Transport: &mockTransport{},
|
||||
}
|
||||
if err := client.Add(cfg); err != nil {
|
||||
// verify we don't error on valid add
|
||||
t.Logf("Add error: %v", err)
|
||||
}
|
||||
|
||||
// We invoke Del immediately.
|
||||
if err := client.Del(host); err != nil {
|
||||
t.Logf("Del error: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
// Reader: Iterates hosts
|
||||
wg.Go(func() {
|
||||
<-start
|
||||
for range 10 {
|
||||
// GetAllInterfaces iterates keys.
|
||||
// With mock transport, this will succeed (returning empty structs)
|
||||
// checking for race conditions.
|
||||
_, _ = client.GetAllInterfaces(ctx)
|
||||
}
|
||||
})
|
||||
|
||||
close(start)
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
func TestClient_AddDel(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
client := MustNew(ctx, []Config{})
|
||||
|
||||
cfg := &Config{
|
||||
Host: "test-host",
|
||||
Transport: &mockTransport{},
|
||||
}
|
||||
if err := client.Add(cfg); err != nil {
|
||||
t.Fatalf("Add failed: %v", err)
|
||||
}
|
||||
|
||||
if err := client.Add(cfg); err == nil {
|
||||
t.Fatal("Expected error adding duplicate host, got nil")
|
||||
}
|
||||
|
||||
// Verify we can retrieve it
|
||||
// Mock transport returns 200 OK with empty body, so GetInterfaces should return empty slice (or error decoding if empty body is not valid JSON array? actually "{}" is valid object, but GetInterfaces expects array for /interfaces?)
|
||||
// Let's check api.go: GetInterfaces calls /interfaces.
|
||||
// We can customize the mock if we want to test success return.
|
||||
// For this test, we just care that it doesn't return "device not found".
|
||||
_, err := client.GetInterfaces(ctx, "test-host")
|
||||
if err != nil && err.Error() == "device not found: test-host" {
|
||||
t.Fatal("Device should exist")
|
||||
}
|
||||
|
||||
if err := client.Del("test-host"); err != nil {
|
||||
t.Fatalf("Del failed: %v", err)
|
||||
}
|
||||
|
||||
if err := client.Del("test-host"); err == nil {
|
||||
t.Fatal("Expected error deleting non-existent host, got nil")
|
||||
}
|
||||
}
|
||||
17
pkg/toughswitch/config.go
Normal file
17
pkg/toughswitch/config.go
Normal file
@@ -0,0 +1,17 @@
|
||||
package toughswitch
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"time"
|
||||
)
|
||||
|
||||
type Config struct {
|
||||
Host string
|
||||
Scheme string
|
||||
Insecure bool
|
||||
Username string
|
||||
Password string
|
||||
Timeout time.Duration
|
||||
// Transport allows customizing the http transport (useful for testing or client middleware)
|
||||
Transport http.RoundTripper
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
package edgeos
|
||||
package toughswitch
|
||||
|
||||
// LoginResponse represents the response from the login endpoint.
|
||||
type LoginResponse struct {
|
||||
Reference in New Issue
Block a user