Check bounds for switched on values and roslyn cleanup

.github/workflows/codeql-analysis.yml

@@ -8,10 +8,10 @@ on:
     # The branches below must be a subset of the branches above
     branches: [ master, main ]
     paths:
-    - '**.cs'    
+    - '**.cs'
   schedule:
     - cron: '30 6 * * 6'
-  workflow_dispatch:  
+  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -36,14 +36,14 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
-        
+
     - name: Set up .NET
       uses: actions/setup-dotnet@v5
       with:
@@ -58,11 +58,11 @@ jobs:
       run: |
         nuget restore "UA Core Library.sln"
         nuget restore "UA Reference.sln"
-        
+
     - name: Build Solution
       run: |
         msbuild.exe "UA Core Library.sln" /p:configuration="Release" /p:UseSharedCompilation=false
         msbuild.exe "UA Reference.sln" /p:configuration="Release" /p:UseSharedCompilation=false
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v4

Applications/ConsoleReferencePublisher/PublishedValuesWrites.cs

@@ -130,6 +130,11 @@ public void Start()
                         case kDataSetNameAllTypes:
                             m_allTypesFields.AddRange(publishedDataSet.DataSetMetaData.Fields);
                             break;
+                        default:
+                            m_logger.LogInformation(
+                                "PublishedValuesWrites.Start: {DataSet} unknown.",
+                                publishedDataSet.Name);
+                            break;
                     }
                 }
             }
@@ -308,6 +313,9 @@ private void UpdateValues(object state)
                             case "DateTime":
                                 IncrementValue(variable, NamespaceIndexSimple);
                                 break;
+                            default:
+                                m_logger.LogDebug("{Variable} not processed.", variable.Name);
+                                break;
                         }
                     }
 
@@ -332,6 +340,7 @@ private void UpdateValues(object state)
         /// <param name="namespaceIndex"></param>
         /// <param name="maxAllowedValue"></param>
         /// <param name="step"></param>
+        /// <exception cref="ServiceResultException"></exception>
         private void IncrementValue(
             FieldMetaData variable,
             ushort namespaceIndex,
@@ -351,7 +360,8 @@ private void IncrementValue(
 
             bool valueUpdated = false;
 
-            switch (TypeInfo.GetBuiltInType(variable.DataType))
+            BuiltInType builtInType = TypeInfo.GetBuiltInType(variable.DataType);
+            switch (builtInType)
             {
                 case BuiltInType.Boolean:
                     if (variable.ValueRank == ValueRanks.Scalar)
@@ -505,6 +515,10 @@ private void IncrementValue(
                         valueUpdated = true;
                     }
                     break;
+                case >= BuiltInType.Null and <= BuiltInType.Enumeration:
+                    break;
+                default:
+                    throw ServiceResultException.Unexpected($"Unexpected BuiltInType {builtInType}");
             }
 
             if (valueUpdated)

Applications/Quickstarts.Servers/Alarms/AlarmHelpers.cs

@@ -28,6 +28,7 @@
  * ======================================================================*/
 
 using System;
+using System.Diagnostics;
 using Opc.Ua;
 
 namespace Alarms
@@ -117,6 +118,11 @@ public static BaseDataVariableState CreateVariable(
                     variable.DataType = DataTypeIds.Double;
                     variable.Value = (double)AlarmDefines.NORMAL_START_VALUE;
                     break;
+                default:
+                    Debug.Fail($"Unexpected data type {dataTypeIdentifier}");
+                    variable.DataType = DataTypeIds.Int32;
+                    variable.Value = AlarmDefines.NORMAL_START_VALUE;
+                    break;
             }
             variable.ValueRank = ValueRanks.Scalar;
             variable.AccessLevel = AccessLevels.CurrentReadOrWrite;

Applications/Quickstarts.Servers/DurableSubscription/DurableDataChangeMonitoredItemQueue.cs

@@ -29,7 +29,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading;
 using Microsoft.Extensions.Logging;
 using Opc.Ua;

Applications/Quickstarts.Servers/MemoryBuffer/MemoryBufferState.cs

@@ -71,14 +71,7 @@ public MemoryBufferState(
 
             SymbolicName = name;
 
-            BuiltInType elementType = BuiltInType.UInt32;
-
-            switch (dataType)
-            {
-                case "Double":
-                    elementType = BuiltInType.Double;
-                    break;
-            }
+            BuiltInType elementType = dataType != "Double" ? BuiltInType.UInt32 : BuiltInType.Double;
 
             CreateBuffer(elementType, count);
         }
@@ -131,14 +124,7 @@ public void CreateBuffer(string elementName, int noOfElements)
                 elementName = "UInt32";
             }
 
-            BuiltInType elementType = BuiltInType.UInt32;
-
-            switch (elementName)
-            {
-                case "Double":
-                    elementType = BuiltInType.Double;
-                    break;
-            }
+            BuiltInType elementType = elementName != "Double" ? BuiltInType.UInt32 : BuiltInType.Double;
 
             CreateBuffer(elementType, noOfElements);
         }
@@ -148,13 +134,12 @@ public void CreateBuffer(string elementName, int noOfElements)
         /// </summary>
         /// <param name="elementType">The type of element.</param>
         /// <param name="noOfElements">The number of elements.</param>
+        /// <exception cref="ServiceResultException"></exception>
         public void CreateBuffer(BuiltInType elementType, int noOfElements)
         {
             lock (m_dataLock)
             {
                 ElementType = elementType;
-                m_elementSize = 1;
-
                 switch (ElementType)
                 {
                     case BuiltInType.UInt32:
@@ -163,6 +148,11 @@ public void CreateBuffer(BuiltInType elementType, int noOfElements)
                     case BuiltInType.Double:
                         m_elementSize = 8;
                         break;
+                    case >= BuiltInType.Null and <= BuiltInType.Enumeration:
+                        m_elementSize = 1;
+                        break;
+                    default:
+                        throw ServiceResultException.Unexpected($"Unexpected BuiltInType {ElementType}");
                 }
 
                 m_lastScanTime = DateTime.UtcNow;
@@ -255,6 +245,7 @@ public ServiceResult ReadTagValue(
         /// <summary>
         /// Handles a write operation for an individual tag.
         /// </summary>
+        /// <exception cref="ServiceResultException"></exception>
         public ServiceResult WriteTagValue(
             ISystemContext context,
             NodeState node,
@@ -332,8 +323,10 @@ public ServiceResult WriteTagValue(
                         bytes = BitConverter.GetBytes(valueToWrite.Value);
                         break;
                     }
-                    default:
+                    case >= BuiltInType.Null and <= BuiltInType.Enumeration:
                         return StatusCodes.BadNodeIdUnknown;
+                    default:
+                        throw ServiceResultException.Unexpected($"Unexpected BuiltInType {ElementType}");
                 }
 
                 for (int ii = 0; ii < bytes.Length; ii++)
@@ -358,6 +351,7 @@ public ServiceResult WriteTagValue(
         /// <summary>
         /// Returns the value at the specified offset.
         /// </summary>
+        /// <exception cref="ServiceResultException"></exception>
         public Variant GetValueAtOffset(int offset)
         {
             lock (m_dataLock)
@@ -378,9 +372,11 @@ public Variant GetValueAtOffset(int offset)
                         return new Variant(BitConverter.ToUInt32(m_buffer, offset));
                     case BuiltInType.Double:
                         return new Variant(BitConverter.ToDouble(m_buffer, offset));
+                    case >= BuiltInType.Null and <= BuiltInType.Enumeration:
+                        return Variant.Null;
+                    default:
+                        throw ServiceResultException.Unexpected($"Bad element type {ElementType}");
                 }
-
-                return Variant.Null;
             }
         }
 

Applications/Quickstarts.Servers/ReferenceServer/ReferenceNodeManager.cs

@@ -113,8 +113,12 @@ private static bool IsAnalogType(BuiltInType builtInType)
                 case BuiltInType.Float:
                 case BuiltInType.Double:
                     return true;
+                case >= BuiltInType.Null and <= BuiltInType.Enumeration:
+                    return false;
+                default:
+                    Debug.Fail($"Unexpected BuiltInType {builtInType}");
+                    return false;
             }
-            return false;
         }
 
         private static Range GetAnalogRange(BuiltInType builtInType)
@@ -141,7 +145,10 @@ private static Range GetAnalogRange(BuiltInType builtInType)
                     return new Range(double.MaxValue, double.MinValue);
                 case BuiltInType.Byte:
                     return new Range(byte.MaxValue, byte.MinValue);
+                case >= BuiltInType.Null and <= BuiltInType.Enumeration:
+                    return new Range(sbyte.MaxValue, sbyte.MinValue);
                 default:
+                    Debug.Fail($"Unexpected BuiltInType {builtInType}");
                     return new Range(sbyte.MaxValue, sbyte.MinValue);
             }
         }

Applications/Quickstarts.Servers/TestData/TestDataSystem.cs

@@ -566,9 +566,9 @@ public object ReadValue(BaseVariableState variable)
                     case Variables.Data_Static_Structure_ScalarStructure_UIntegerValue:
                     case Variables.Data_Dynamic_Structure_ScalarStructure_UIntegerValue:
                         return new Variant(m_generator.GetRandomUInteger());
+                    default:
+                        return null;
                 }
-
-                return null;
             }
         }
 

Directory.Packages.props

@@ -29,10 +29,10 @@
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
     <PackageVersion Include="NUnit" Version="4.4.0" />
     <PackageVersion Include="NUnit.Console" Version="3.20.1" />
-    <PackageVersion Include="NUnit3TestAdapter" Version="5.1.0" />
+    <PackageVersion Include="NUnit3TestAdapter" Version="5.2.0" />
     <PackageVersion Include="PolySharp" Version="1.15.0" />
-    <PackageVersion Include="Roslynator.Analyzers" Version="4.14.0" />
-    <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.14.0" />
+    <PackageVersion Include="Roslynator.Analyzers" Version="4.14.1" />
+    <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.14.1" />
     <PackageVersion Include="SharpFuzz" Version="2.2.0" />
     <PackageVersion Include="Serilog" Version="4.3.0" />
     <PackageVersion Include="Serilog.Expressions" Version="5.0.0" />
@@ -46,7 +46,7 @@
     <PackageVersion Include="System.IO.Compression" Version="4.3.0" />
     <PackageVersion Include="System.Net.NetworkInformation" Version="4.3.0" />
     <PackageVersion Include="System.Collections.Immutable" Version="9.0.9" />
-    <PackageVersion Include="System.Text.Json" Version="9.0.5" />
+    <PackageVersion Include="System.Text.Json" Version="9.0.9" />
     <PackageVersion Include="System.Private.Uri" Version="4.3.2" />
     <PackageVersion Include="System.Runtime.InteropServices.RuntimeInformation" Version="4.3.0" />
     <PackageVersion Include="System.Security.Cryptography.Cng" Version="5.0.0" />

Fuzzing/Encoders/Fuzz/FuzzableCode.BinaryDecoder.cs

@@ -180,10 +180,10 @@ internal static IEncodeable FuzzBinaryDecoderCore(
                         {
                             return null;
                         }
-                        break;
+                        goto default;
+                    default:
+                        throw;
                 }
-
-                throw;
             }
         }
 

Fuzzing/Encoders/Fuzz/FuzzableCode.JsonDecoder.cs

@@ -132,10 +132,10 @@ internal static IEncodeable FuzzJsonDecoderCore(string json, bool throwAll = fal
                         {
                             return null;
                         }
-                        break;
+                        goto default;
+                    default:
+                        throw;
                 }
-
-                throw;
             }
         }
     }

Fuzzing/Encoders/Fuzz/FuzzableCode.XmlDecoder.cs

@@ -170,15 +170,14 @@ internal static IEncodeable FuzzXmlDecoderCore(Stream stream, bool throwAll = fa
                         {
                             return null;
                         }
-                        break;
+                        goto default;
+                    default:
+                        Console.WriteLine(
+                            "Unexpected ServiceResultException: {0} {1}",
+                            (StatusCode)sre.StatusCode,
+                            sre.Message);
+                        throw;
                 }
-
-                Console.WriteLine(
-                    "Unexpected ServiceResultException: {0} {1}",
-                    (StatusCode)sre.StatusCode,
-                    sre.Message);
-
-                throw;
             }
         }
     }

Libraries/Opc.Ua.Client.ComplexTypes/ComplexTypeSystem.cs

@@ -29,6 +29,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
@@ -1305,8 +1306,14 @@ private static bool IsAllowSubTypes(StructureDefinition structureDefinition)
                 case StructureType.UnionWithSubtypedValues:
                 case StructureType.StructureWithSubtypedValues:
                     return true;
+                case StructureType.Structure:
+                case StructureType.StructureWithOptionalFields:
+                case StructureType.Union:
+                    return false;
+                default:
+                    Debug.Fail($"Unexpected StructureType {structureDefinition.StructureType}.");
+                    return false;
             }
-            return false;
         }
 
         private async Task<bool> IsAbstractTypeAsync(
@@ -1479,8 +1486,7 @@ private static void SplitAndSortDictionary(
                 }
                 else
                 {
-                    throw ServiceResultException.Create(
-                        StatusCodes.BadUnexpectedError,
+                    throw ServiceResultException.Unexpected(
                         "Unexpected Type in binary schema: {0}.",
                         item.GetType().Name);
                 }

Libraries/Opc.Ua.Client.ComplexTypes/DataTypeDefinitionExtension.cs

@@ -373,15 +373,16 @@ private static NodeId ToNodeId(
                         return DataTypeIds.BaseDataType;
                     case "ExtensionObject":
                         return DataTypeIds.Structure;
+                    default:
+                        System.Reflection.FieldInfo internalField = typeof(DataTypeIds).GetField(
+                            typeName.Name);
+                        if (internalField == null)
+                        {
+                            // The type was not found in the internal type factory.
+                            return NodeId.Null;
+                        }
+                        return (NodeId)internalField.GetValue(typeName.Name);
                 }
-                System.Reflection.FieldInfo internalField = typeof(DataTypeIds).GetField(
-                    typeName.Name);
-                if (internalField == null)
-                {
-                    // The type was not found in the internal type factory.
-                    return NodeId.Null;
-                }
-                return (NodeId)internalField.GetValue(typeName.Name);
             }
             if (!typeCollection.TryGetValue(typeName, out NodeId referenceId))
             {