fix: avoiding possible data races when accessing shared maps

internal/netbox/inventory/get_items.go

@@ -13,3 +13,57 @@ func (nbi *NetboxInventory) GetVlan(vlanGroupID int, vlanID int) *objects.Vlan {
 	}
 	return nbi.VlansIndexByVlanGroupIDAndVID[vlanGroupID][vlanID]
 }
+
+func (nbi *NetboxInventory) GetTenant(tenantName string) (*objects.Tenant, bool) {
+	nbi.TenantsLock.Lock()
+	defer nbi.TenantsLock.Unlock()
+	if _, ok := nbi.TenantsIndexByName[tenantName]; !ok {
+		return nil, false
+	}
+	return nbi.TenantsIndexByName[tenantName], true
+}
+
+func (nbi *NetboxInventory) GetSite(siteName string) (*objects.Site, bool) {
+	nbi.SitesLock.Lock()
+	defer nbi.SitesLock.Unlock()
+	if _, ok := nbi.SitesIndexByName[siteName]; !ok {
+		return nil, false
+	}
+	return nbi.SitesIndexByName[siteName], true
+}
+
+func (nbi *NetboxInventory) GetVlanGroup(vlanGroupName string) (*objects.VlanGroup, bool) {
+	nbi.VlanGroupsLock.Lock()
+	defer nbi.VlanGroupsLock.Unlock()
+	if _, ok := nbi.VlanGroupsIndexByName[vlanGroupName]; !ok {
+		return nil, false
+	}
+	return nbi.VlanGroupsIndexByName[vlanGroupName], true
+}
+
+func (nbi *NetboxInventory) GetClusterGroup(clusterGroupName string) (*objects.ClusterGroup, bool) {
+	nbi.ClusterGroupsLock.Lock()
+	defer nbi.ClusterGroupsLock.Unlock()
+	if _, ok := nbi.ClusterGroupsIndexByName[clusterGroupName]; !ok {
+		return nil, false
+	}
+	return nbi.ClusterGroupsIndexByName[clusterGroupName], true
+}
+
+func (nbi *NetboxInventory) GetCluster(clusterName string) (*objects.Cluster, bool) {
+	nbi.ClustersLock.Lock()
+	defer nbi.ClustersLock.Unlock()
+	if _, ok := nbi.ClustersIndexByName[clusterName]; !ok {
+		return nil, false
+	}
+	return nbi.ClustersIndexByName[clusterName], true
+}
+
+func (nbi *NetboxInventory) GetDevice(deviceName string, siteID int) (*objects.Device, bool) {
+	nbi.DevicesLock.Lock()
+	defer nbi.DevicesLock.Unlock()
+	if device, ok := nbi.DevicesIndexByNameAndSiteID[deviceName][siteID]; ok {
+		return device, true
+	}
+	return nil, false
+}

internal/source/common/utils.go

@@ -22,7 +22,7 @@ func MatchClusterToTenant(ctx context.Context, nbi *inventory.NetboxInventory, c
 		return nil, fmt.Errorf("matching cluster to tenant: %s", err)
 	}
 	if tenantName != "" {
-		tenant, ok := nbi.TenantsIndexByName[tenantName]
+		tenant, ok := nbi.GetTenant(tenantName)
 		if !ok {
 			tenant, err := nbi.AddTenant(ctx, &objects.Tenant{
 				Name: tenantName,
@@ -50,7 +50,7 @@ func MatchClusterToSite(ctx context.Context, nbi *inventory.NetboxInventory, clu
 		return nil, fmt.Errorf("matching cluster to tenant: %s", err)
 	}
 	if siteName != "" {
-		site, ok := nbi.SitesIndexByName[siteName]
+		site, ok := nbi.GetSite(siteName)
 		if !ok {
 			newSite, err := nbi.AddSite(ctx, &objects.Site{
 				Name: siteName,
@@ -71,14 +71,15 @@ func MatchClusterToSite(ctx context.Context, nbi *inventory.NetboxInventory, clu
 // In case there is no match or regexRelations is nil, it will return default VlanGroup.
 func MatchVlanToGroup(ctx context.Context, nbi *inventory.NetboxInventory, vlanName string, regexRelations map[string]string) (*objects.VlanGroup, error) {
 	if regexRelations == nil {
-		return nbi.VlanGroupsIndexByName[objects.DefaultVlanGroupName], nil
+		vlanGroup, _ := nbi.GetVlanGroup(objects.DefaultVlanGroupName)
+		return vlanGroup, nil
 	}
 	vlanGroupName, err := utils.MatchStringToValue(vlanName, regexRelations)
 	if err != nil {
 		return nil, fmt.Errorf("matching vlan to group: %s", err)
 	}
 	if vlanGroupName != "" {
-		vlanGroup, ok := nbi.VlanGroupsIndexByName[vlanGroupName]
+		vlanGroup, ok := nbi.GetVlanGroup(vlanGroupName)
 		if !ok {
 			// Create vlanGroup
 			vlanGroup, err = nbi.AddVlanGroup(ctx, &objects.VlanGroup{
@@ -94,7 +95,8 @@ func MatchVlanToGroup(ctx context.Context, nbi *inventory.NetboxInventory, vlanN
 		return vlanGroup, nil
 	}
 
-	return nbi.VlanGroupsIndexByName[objects.DefaultVlanGroupName], nil
+	vlanGroup, _ := nbi.GetVlanGroup(objects.DefaultVlanGroupName)
+	return vlanGroup, nil
 }
 
 // Function that matches vlanName to tenant using vlanTenantRelations regex relations map.
@@ -109,7 +111,7 @@ func MatchVlanToTenant(ctx context.Context, nbi *inventory.NetboxInventory, vlan
 		return nil, fmt.Errorf("matching vlan to tenant: %s", err)
 	}
 	if tenantName != "" {
-		tenant, ok := nbi.TenantsIndexByName[tenantName]
+		tenant, ok := nbi.GetTenant(tenantName)
 		if !ok {
 			tenant, err := nbi.AddTenant(ctx, &objects.Tenant{
 				Name: tenantName,
@@ -138,7 +140,7 @@ func MatchHostToSite(ctx context.Context, nbi *inventory.NetboxInventory, hostNa
 		return nil, fmt.Errorf("matching host to site: %s", err)
 	}
 	if siteName != "" {
-		site, ok := nbi.SitesIndexByName[siteName]
+		site, ok := nbi.GetSite(siteName)
 		if !ok {
 			newSite, err := nbi.AddSite(ctx, &objects.Site{
 				Name: siteName,
@@ -151,7 +153,8 @@ func MatchHostToSite(ctx context.Context, nbi *inventory.NetboxInventory, hostNa
 		}
 		return site, nil
 	}
-	return nbi.SitesIndexByName[constants.DefaultSite], nil
+	site, _ := nbi.GetSite(constants.DefaultSite)
+	return site, nil
 }
 
 // Function that matches Host from hostName to Tenant using hostTenantRelations.
@@ -166,7 +169,7 @@ func MatchHostToTenant(ctx context.Context, nbi *inventory.NetboxInventory, host
 		return nil, fmt.Errorf("matching host to tenant: %s", err)
 	}
 	if tenantName != "" {
-		site, ok := nbi.TenantsIndexByName[tenantName]
+		site, ok := nbi.GetTenant(tenantName)
 		if !ok {
 			tenant, err := nbi.AddTenant(ctx, &objects.Tenant{
 				Name: tenantName,
@@ -194,7 +197,7 @@ func MatchVMToTenant(ctx context.Context, nbi *inventory.NetboxInventory, vmName
 		return nil, fmt.Errorf("matching vm to tenant: %s", err)
 	}
 	if tenantName != "" {
-		site, ok := nbi.TenantsIndexByName[tenantName]
+		site, ok := nbi.GetTenant(tenantName)
 		if !ok {
 			tenant, err := nbi.AddTenant(ctx, &objects.Tenant{
 				Name: tenantName,

internal/source/ovirt/ovirt_sync.go

@@ -126,7 +126,7 @@ func (o *OVirtSource) syncClusters(nbi *inventory.NetboxInventory) error {
 			if mappedName, ok := o.DatacenterClusterGroupRelations[clusterGroupName]; ok {
 				clusterGroupName = mappedName
 			}
-			clusterGroup = nbi.ClusterGroupsIndexByName[clusterGroupName]
+			clusterGroup, _ = nbi.GetClusterGroup(clusterGroupName)
 		}
 
 		clusterSite, err := common.MatchClusterToSite(o.Ctx, nbi, clusterName, o.ClusterSiteRelations)
@@ -170,7 +170,7 @@ func (o *OVirtSource) syncHosts(nbi *inventory.NetboxInventory) error {
 		if !exists {
 			o.Logger.Warningf(o.Ctx, "name of host with id=%s is empty", hostID)
 		}
-		hostCluster := nbi.ClustersIndexByName[o.Clusters[host.MustCluster().MustId()].MustName()]
+		hostCluster, _ := nbi.GetCluster(o.Clusters[host.MustCluster().MustId()].MustName())
 
 		hostSite, err := common.MatchHostToSite(o.Ctx, nbi, hostName, o.HostSiteRelations)
 		if err != nil {
@@ -706,7 +706,7 @@ func (o *OVirtSource) extractVMData(nbi *inventory.NetboxInventory, vmID string,
 	cluster, exists := vm.Cluster()
 	if exists {
 		if _, ok := o.Clusters[cluster.MustId()]; ok {
-			vmCluster = nbi.ClustersIndexByName[o.Clusters[cluster.MustId()].MustName()]
+			vmCluster, _ = nbi.GetCluster(o.Clusters[cluster.MustId()].MustName())
 		}
 	}
 
@@ -737,7 +737,7 @@ func (o *OVirtSource) extractVMData(nbi *inventory.NetboxInventory, vmID string,
 	if host, exists := vm.Host(); exists {
 		if oHost, ok := o.Hosts[host.MustId()]; ok {
 			if oHostName, ok := oHost.Name(); ok {
-				vmHostDevice = nbi.DevicesIndexByNameAndSiteID[oHostName][vmSite.ID]
+				vmHostDevice, _ = nbi.GetDevice(oHostName, vmSite.ID)
 			}
 		}
 	}
@@ -1017,7 +1017,7 @@ func (o *OVirtSource) syncVMNics(nbi *inventory.NetboxInventory, ovirtVM *ovirts
 								o.Logger.Warningf(o.Ctx, "match vlan to group: %s", err)
 								continue
 							}
-							nicVlans = []*objects.Vlan{nbi.VlansIndexByVlanGroupIDAndVID[vlanGroup.ID][int(vlanID)]}
+							nicVlans = []*objects.Vlan{nbi.GetVlan(vlanGroup.ID, int(vlanID))}
 							nicMode = &objects.VMInterfaceModeTagged
 						}
 					}

internal/source/vmware/vmware_sync.go

@@ -95,7 +95,7 @@ func (vc *VmwareSource) syncClusters(nbi *inventory.NetboxInventory) error {
 		if mappedName, ok := vc.DatacenterClusterGroupRelations[clusterGroupName]; ok {
 			clusterGroupName = mappedName
 		}
-		clusterGroup = nbi.ClusterGroupsIndexByName[clusterGroupName]
+		clusterGroup, _ = nbi.GetClusterGroup(clusterGroupName)
 
 		clusterSite, err := common.MatchClusterToSite(vc.Ctx, nbi, clusterName, vc.ClusterSiteRelations)
 		if err != nil {
@@ -146,7 +146,7 @@ func (vc *VmwareSource) syncHosts(nbi *inventory.NetboxInventory) error {
 			return fmt.Errorf("hostTenant: %s", err)
 		}
 
-		hostCluster := nbi.ClustersIndexByName[vc.Clusters[vc.Host2Cluster[hostID]].Name]
+		hostCluster, _ := nbi.GetCluster(vc.Clusters[vc.Host2Cluster[hostID]].Name)
 		if hostCluster == nil {
 			// Create a hypothetical cluster https://github.com/bl4ko/netbox-ssot/issues/141
 			hostCluster, err = vc.createHypotheticalCluster(nbi, hostName, hostSite, hostTenant)
@@ -736,7 +736,7 @@ func (vc *VmwareSource) syncVM(nbi *inventory.NetboxInventory, vmKey string, vm
 	if err != nil {
 		return fmt.Errorf("vm's Site: %s", err)
 	}
-	vmHost := nbi.DevicesIndexByNameAndSiteID[vmHostName][vmSite.ID]
+	vmHost, _ := nbi.GetDevice(vmHostName, vmSite.ID)
 
 	// Cluster of the vm is same as the host
 	vmCluster := vmHost.Cluster