DeviceSite, DeviceRegion and DeviceTags properties added to the version output

- filter by site_name allowed too

Author: businessbean

README.md

@@ -43,7 +43,7 @@ resource_types:
     check_every: never
     source:
       repository: registry.fqdn/org/concourse-netbox-resource
-      tag: 0.1.0-20250619163905
+      tag: 0.1.0
 
 resources:
   - name: example.netbox
@@ -55,6 +55,7 @@ resources:
       token: "your-api-token"
       filter:
         site_name: ["site 1"]
+        region_name: ["region 1"]
         tag: ["tag1"]
         role: ["server"]
         device_id: [123]

internal/app/check.go

@@ -25,6 +25,7 @@ The output will be a JSON array of objects with their latest versions.
 		},
 		"filter": {
 			"site_name": ["My Site"],
+			"region_name": ["My Region"],
 			"tag": ["my-tag"],
 			"role": ["server"],
 			"device_id": [123],

internal/concourse/types.go

@@ -27,6 +27,9 @@ type Version struct {
 	DeviceId            string `json:"device_id,omitempty"`
 	DeviceName          string `json:"device_name"`
 	DeviceRole          string `json:"device_role"`
+	DeviceSite          string `json:"device_site"`
+	DeviceRegion        string `json:"device_region,omitempty"`
+	DeviceTags          string `json:"device_tags,omitempty"`
 	DeviceApiUrl        string `json:"device_api_url,omitempty"`
 	DeviceDisplayUrl    string `json:"device_display_url,omitempty"`
 	ConfigContext       string `json:"config_context,omitempty"`

internal/filter/netbox.go

@@ -2,6 +2,7 @@ package filter
 
 type NetboxObject struct {
 	SiteName         []string        `json:"site_name,omitempty"`
+	RegionName       []string        `json:"region_name,omitempty"`
 	Tag              []string        `json:"tag,omitempty"`
 	Role             []string        `json:"role,omitempty"`
 	DeviceId         []int32         `json:"device_id,omitempty"`

internal/helper/tests.go

@@ -99,6 +99,8 @@ var (
 	DeviceDisplayUrl string = "http://netbox.example.local/dcim/devices"
 	DeviceRoleId     int32  = 8
 	DeviceRoleSlug   string = "server"
+	DeviceSiteId     int32  = 1
+	DeviceSiteSlug   string = "test-site"
 )
 
 func EnsureFolder(path string) error {

internal/netbox/config_context_test.go

@@ -1,6 +1,7 @@
 package netbox
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"testing"
@@ -27,13 +28,18 @@ func TestConfigContextParsing(t *testing.T) {
 	role.SetId(helper.DeviceRoleId)
 	role.SetSlug(helper.DeviceRoleSlug)
 
+	site := netbox.BriefSite{}
+	site.SetId(helper.DeviceSiteId)
+	site.SetSlug(helper.DeviceSiteSlug)
+
 	device.Id = helper.DeviceId
 	device.Url = helper.DeviceApiUrl + fmt.Sprintf("/%d/", device.Id)
 	device.Display = helper.DeviceName
 	displayUrl := helper.DeviceDisplayUrl + fmt.Sprintf("/%d/", device.Id)
 	device.DisplayUrl = &displayUrl
 	device.LastUpdated = updatedTime
 	device.Role = role
+	device.Site = site
 	device.SetConfigContext(helper.NetBoxConfigContextData)
 
 	// Test cases
@@ -71,7 +77,7 @@ func TestConfigContextParsing(t *testing.T) {
 			}
 
 			currentDevice := *device
-			result, err := populateDeviceDetails(helper.DeviceName, input, currentDevice)
+			result, err := populateDeviceDetails(helper.DeviceName, input, currentDevice, context.Background())
 			if err != nil {
 				t.Fatalf("Error in populateDeviceDetails: %v", err)
 			}

internal/netbox/query.go

@@ -20,6 +20,7 @@ var (
 	referenceTime   time.Time
 	output          []concourse.Version
 	err             error
+	siteRegionCache map[int32]string
 )
 
 func Query(input concourse.Input, ctx context.Context) ([]concourse.Version, error) {
@@ -35,6 +36,12 @@ func Query(input concourse.Input, ctx context.Context) ([]concourse.Version, err
 		return nil, fmt.Errorf("error during device query: %w", err)
 	}
 
+	// Pre-fetch all site regions to avoid per-device API calls
+	siteRegionCache, err = fetchSiteRegions(client, ctx)
+	if err != nil {
+		return nil, fmt.Errorf("error during site region query: %w", err)
+	}
+
 	output, err = fetchDetailsFromDeviceList(input, deviceList, ctx)
 	if err != nil {
 		return nil, fmt.Errorf("error during device details query: %w", err)
@@ -47,6 +54,9 @@ func createDeviceQuery(client *netbox.APIClient, netboxFilter filter.NetboxObjec
 	if len(netboxFilter.SiteName) > 0 {
 		query = query.Site(netboxFilter.SiteName)
 	}
+	if len(netboxFilter.RegionName) > 0 {
+		query = query.Region(netboxFilter.RegionName)
+	}
 	if len(netboxFilter.Tag) > 0 {
 		query = query.Tag(netboxFilter.Tag)
 	}
@@ -149,12 +159,12 @@ func fetchDetailsFromDeviceList(input concourse.Input, deviceList []netbox.Devic
 				return nil, fmt.Errorf("error during server interface query: %w", err)
 			}
 
-			output, err = populateInterfaceDetails(name, input, d, interfaceList)
+			output, err = populateInterfaceDetails(name, input, d, interfaceList, ctx)
 			if err != nil {
 				return nil, fmt.Errorf("error during server interface details query: %w", err)
 			}
 		} else {
-			output, err = populateDeviceDetails(name, input, d)
+			output, err = populateDeviceDetails(name, input, d, ctx)
 			if err != nil {
 				return nil, fmt.Errorf("error during device details query: %w", err)
 			}
@@ -167,7 +177,7 @@ func fetchDetailsFromDeviceList(input concourse.Input, deviceList []netbox.Devic
 	return output, nil
 }
 
-func populateInterfaceDetails(name string, input concourse.Input, device netbox.DeviceWithConfigContext, interfaceList []netbox.Interface) ([]concourse.Version, error) {
+func populateInterfaceDetails(name string, input concourse.Input, device netbox.DeviceWithConfigContext, interfaceList []netbox.Interface, ctx context.Context) ([]concourse.Version, error) {
 	for _, iface := range interfaceList {
 		lastUpdatedTime, referenceTime, err = getTimestamps(device, input)
 		if err != nil {
@@ -195,13 +205,19 @@ func populateInterfaceDetails(name string, input concourse.Input, device netbox.
 				interfaceDisplayUrl = *iface.DisplayUrl
 			}
 
+			deviceRegion := getSiteRegion(device.Site.GetId())
+			deviceTags := getDeviceTags(device)
+
 			output = append(output, concourse.Version{
 				Id:                  fmt.Sprintf("%d", iface.Id),
 				LastUpdated:         lastUpdatedTime.Format(time.RFC3339),
 				ObjectType:          "interfaces",
 				DeviceId:            fmt.Sprintf("%d", device.Id),
 				DeviceName:          name,
 				DeviceRole:          device.Role.GetSlug(),
+				DeviceSite:          device.Site.GetSlug(),
+				DeviceRegion:        deviceRegion,
+				DeviceTags:          deviceTags,
 				DeviceApiUrl:        device.Url,
 				DeviceDisplayUrl:    deviceDisplayUrl,
 				ConfigContext:       configContext,
@@ -215,7 +231,7 @@ func populateInterfaceDetails(name string, input concourse.Input, device netbox.
 	return output, nil
 }
 
-func populateDeviceDetails(name string, input concourse.Input, device netbox.DeviceWithConfigContext) ([]concourse.Version, error) {
+func populateDeviceDetails(name string, input concourse.Input, device netbox.DeviceWithConfigContext, ctx context.Context) ([]concourse.Version, error) {
 	lastUpdatedTime, referenceTime, err = getTimestamps(device, input)
 	if err != nil {
 		return nil, fmt.Errorf("error parsing netbox timestamps because of: %w", err)
@@ -237,12 +253,18 @@ func populateDeviceDetails(name string, input concourse.Input, device netbox.Dev
 			displayUrl = *device.DisplayUrl
 		}
 
+		deviceRegion := getSiteRegion(device.Site.GetId())
+		deviceTags := getDeviceTags(device)
+
 		output = append(output, concourse.Version{
 			Id:               fmt.Sprintf("%d", device.Id),
 			LastUpdated:      lastUpdatedTime.Format(time.RFC3339),
 			ObjectType:       "devices",
 			DeviceName:       name,
 			DeviceRole:       device.Role.GetSlug(),
+			DeviceSite:       device.Site.GetSlug(),
+			DeviceRegion:     deviceRegion,
+			DeviceTags:       deviceTags,
 			DeviceApiUrl:     device.Url,
 			DeviceDisplayUrl: displayUrl,
 			ConfigContext:    configContext,
@@ -298,3 +320,54 @@ func getTimestamps(device any, input concourse.Input) (*time.Time, time.Time, er
 	}
 	return lastUpdatedTime, referenceTime, nil
 }
+
+func fetchSiteRegions(client *netbox.APIClient, ctx context.Context) (map[int32]string, error) {
+	cache := make(map[int32]string)
+	if client == nil {
+		return cache, nil
+	}
+
+	limit := int32(100)
+	offset := int32(0)
+	for {
+		query := client.DcimAPI.DcimSitesList(ctx).Limit(limit).Offset(offset)
+		siteResponse, _, err := query.Execute()
+		if err != nil {
+			return nil, fmt.Errorf("error during DcimSitesList query: %w", err)
+		}
+		for _, site := range siteResponse.Results {
+			region := ""
+			if site.Region.IsSet() && site.Region.Get() != nil {
+				region = site.Region.Get().GetSlug()
+			}
+			cache[site.Id] = region
+		}
+		if !siteResponse.Next.IsSet() || siteResponse.Next.Get() == nil || *siteResponse.Next.Get() == "" || len(siteResponse.Results) == 0 {
+			break
+		}
+		offset += limit
+	}
+	return cache, nil
+}
+
+func getSiteRegion(siteId int32) string {
+	if siteRegionCache == nil {
+		return ""
+	}
+	if region, ok := siteRegionCache[siteId]; ok {
+		return region
+	}
+	return ""
+}
+
+func getDeviceTags(device netbox.DeviceWithConfigContext) string {
+	tags := device.GetTags()
+	if len(tags) == 0 {
+		return ""
+	}
+	tagSlugs := make([]string, 0, len(tags))
+	for _, tag := range tags {
+		tagSlugs = append(tagSlugs, tag.GetSlug())
+	}
+	return strings.Join(tagSlugs, ",")
+}