Merge branch 'update' into 'main'



Microsoft Visual Studio Solution File, Format Version 12.00

# Visual Studio Version 17

VisualStudioVersion = 17.10.35004.147

MinimumVisualStudioVersion = 10.0.40219.1

Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CodeBeamer", "CodeBeamer\CodeBeamer.csproj", "{C1A32694-564E-4E82-9303-A4F0C60E819E}"

EndProject

Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Common", "..\Common\Common\Common.csproj", "{147DFD08-C22C-4E4E-9031-0A3041DC317F}"

EndProject

Global

	GlobalSection(SolutionConfigurationPlatforms) = preSolution

		Debug|Any CPU = Debug|Any CPU

		Release|Any CPU = Release|Any CPU

	EndGlobalSection

	GlobalSection(ProjectConfigurationPlatforms) = postSolution

		{C1A32694-564E-4E82-9303-A4F0C60E819E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU

		{C1A32694-564E-4E82-9303-A4F0C60E819E}.Debug|Any CPU.Build.0 = Debug|Any CPU

		{C1A32694-564E-4E82-9303-A4F0C60E819E}.Release|Any CPU.ActiveCfg = Release|Any CPU

		{C1A32694-564E-4E82-9303-A4F0C60E819E}.Release|Any CPU.Build.0 = Release|Any CPU

		{147DFD08-C22C-4E4E-9031-0A3041DC317F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU

		{147DFD08-C22C-4E4E-9031-0A3041DC317F}.Debug|Any CPU.Build.0 = Debug|Any CPU

		{147DFD08-C22C-4E4E-9031-0A3041DC317F}.Release|Any CPU.ActiveCfg = Release|Any CPU

		{147DFD08-C22C-4E4E-9031-0A3041DC317F}.Release|Any CPU.Build.0 = Release|Any CPU

	EndGlobalSection

	GlobalSection(SolutionProperties) = preSolution

		HideSolutionNode = FALSE

	EndGlobalSection

	GlobalSection(ExtensibilityGlobals) = postSolution

		SolutionGuid = {30C5E663-34B1-43C5-B214-3C5A9BBCAD7F}

	EndGlobalSection

EndGlobal

# Entfernen Sie die folgende Zeile, wenn Sie EDITORCONFIG-Einstellungen von höheren Verzeichnissen vererben möchten.

root = true

# C#-Dateien

[*.cs]

#### Wichtige EditorConfig-Optionen ####

# Einzüge und Abstände

indent_size = 4

indent_style = space

tab_width = 4

# Einstellungen für neue Zeilen

end_of_line = crlf

insert_final_newline = false

#### .NET-Codierungskonventionen ####

# Using-Direktiven organisieren

dotnet_separate_import_directive_groups = true

dotnet_sort_system_directives_first = true

file_header_template = unset

# this.- und Me.-Einstellungen

dotnet_style_qualification_for_event = false

dotnet_style_qualification_for_field = true

dotnet_style_qualification_for_method = false

dotnet_style_qualification_for_property = true

# Einstellungen für Sprachschlüsselwörter und BCL-Typen

dotnet_style_predefined_type_for_locals_parameters_members = true

dotnet_style_predefined_type_for_member_access = true

# Einstellungen für Klammern

dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity

dotnet_style_parentheses_in_other_binary_operators = always_for_clarity

dotnet_style_parentheses_in_other_operators = never_if_unnecessary

dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity

# Einstellungen für Modifizierer

dotnet_style_require_accessibility_modifiers = for_non_interface_members

# Einstellungen für Ausdrucksebene

dotnet_style_coalesce_expression = true

dotnet_style_collection_initializer = true

dotnet_style_explicit_tuple_names = true

dotnet_style_namespace_match_folder = true

dotnet_style_null_propagation = true

dotnet_style_object_initializer = true

dotnet_style_operator_placement_when_wrapping = beginning_of_line

dotnet_style_prefer_auto_properties = true

dotnet_style_prefer_compound_assignment = true

dotnet_style_prefer_conditional_expression_over_assignment = true

dotnet_style_prefer_conditional_expression_over_return = true

dotnet_style_prefer_inferred_anonymous_type_member_names = true

dotnet_style_prefer_inferred_tuple_names = true

dotnet_style_prefer_is_null_check_over_reference_equality_method = true

dotnet_style_prefer_simplified_boolean_expressions = true

dotnet_style_prefer_simplified_interpolation = true

# Einstellungen für Felder

dotnet_style_readonly_field = true

# Einstellungen für Parameter

dotnet_code_quality_unused_parameters = all

# Unterdrückungseinstellungen

dotnet_remove_unnecessary_suppression_exclusions = none

# Einstellungen für neue Zeilen

dotnet_style_allow_multiple_blank_lines_experimental = false:suggestion

dotnet_style_allow_statement_immediately_after_block_experimental = true

#### C#-Codierungskonventionen ####

# Var-Einstellungen

csharp_style_var_elsewhere = false

csharp_style_var_for_built_in_types = false

csharp_style_var_when_type_is_apparent = false

# Ausdruckskörpermember

csharp_style_expression_bodied_accessors = true

csharp_style_expression_bodied_constructors = false

csharp_style_expression_bodied_indexers = true

csharp_style_expression_bodied_lambdas = true

csharp_style_expression_bodied_local_functions = false

csharp_style_expression_bodied_methods = false

csharp_style_expression_bodied_operators = false

csharp_style_expression_bodied_properties = true

csharp_style_namespace_declarations=file_scoped:suggestion

# Einstellungen für den Musterabgleich

csharp_style_pattern_matching_over_as_with_null_check = true

csharp_style_pattern_matching_over_is_with_cast_check = true

csharp_style_prefer_not_pattern = true

csharp_style_prefer_pattern_matching = true

csharp_style_prefer_switch_expression = true

# Einstellungen für NULL-Überprüfung

csharp_style_conditional_delegate_call = true

# Einstellungen für Modifizierer

csharp_prefer_static_local_function = true

csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async

# Einstellungen für Codeblöcke

csharp_prefer_braces = when_multiline

csharp_prefer_simple_using_statement = false

# Einstellungen für Ausdrucksebene

csharp_prefer_simple_default_expression = true

csharp_style_deconstructed_variable_declaration = true

csharp_style_implicit_object_creation_when_type_is_apparent = true

csharp_style_inlined_variable_declaration = true

csharp_style_pattern_local_over_anonymous_function = true

csharp_style_prefer_index_operator = true

csharp_style_prefer_range_operator = true

csharp_style_throw_expression = true

csharp_style_unused_value_assignment_preference = discard_variable

csharp_style_unused_value_expression_statement_preference = discard_variable

# Einstellungen für using-Anweisungen

csharp_using_directive_placement = outside_namespace

# Einstellungen für neue Zeilen

csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true

csharp_style_allow_blank_lines_between_consecutive_braces_experimental = false:suggestion

csharp_style_allow_embedded_statements_on_same_line_experimental = false

#### C#-Formatierungsregeln ####

# Einstellungen für neue Zeilen

csharp_new_line_before_catch = true

csharp_new_line_before_else = true

csharp_new_line_before_finally = true

csharp_new_line_before_members_in_anonymous_types = true

csharp_new_line_before_members_in_object_initializers = true

csharp_new_line_before_open_brace = control_blocks,properties,types

csharp_new_line_between_query_expression_clauses = true

# Einstellungen für Einrückung

csharp_indent_block_contents = true

csharp_indent_braces = false

csharp_indent_case_contents = true

csharp_indent_case_contents_when_block = false

csharp_indent_labels = no_change

csharp_indent_switch_labels = true

# Einstellungen für Abstände

csharp_space_after_cast = false

csharp_space_after_colon_in_inheritance_clause = true

csharp_space_after_comma = true

csharp_space_after_dot = false

csharp_space_after_keywords_in_control_flow_statements = true

csharp_space_after_semicolon_in_for_statement = true

csharp_space_around_binary_operators = before_and_after

csharp_space_around_declaration_statements = false

csharp_space_before_colon_in_inheritance_clause = true

csharp_space_before_comma = false

csharp_space_before_dot = false

csharp_space_before_open_square_brackets = false

csharp_space_before_semicolon_in_for_statement = false

csharp_space_between_empty_square_brackets = false

csharp_space_between_method_call_empty_parameter_list_parentheses = false

csharp_space_between_method_call_name_and_opening_parenthesis = false

csharp_space_between_method_call_parameter_list_parentheses = true

csharp_space_between_method_declaration_empty_parameter_list_parentheses = false

csharp_space_between_method_declaration_name_and_open_parenthesis = false

csharp_space_between_method_declaration_parameter_list_parentheses = true

csharp_space_between_parentheses = control_flow_statements,expressions

csharp_space_between_square_brackets = false

# Umbrucheinstellungen

csharp_preserve_single_line_blocks = true

csharp_preserve_single_line_statements = false

#### Benennungsstile ####

# Benennungsregeln

dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion

dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface

dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i

dotnet_naming_rule.types_should_be_pascal_case.severity = silent

dotnet_naming_rule.types_should_be_pascal_case.symbols = types

dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case

dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = silent

dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members

dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case

# Symbolspezifikationen

dotnet_naming_symbols.interface.applicable_kinds = interface

dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected

dotnet_naming_symbols.interface.required_modifiers = 

dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum

dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected

dotnet_naming_symbols.types.required_modifiers = 

dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method

dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected

dotnet_naming_symbols.non_field_members.required_modifiers = 

# Benennungsstile

dotnet_naming_style.pascal_case.required_prefix = 

dotnet_naming_style.pascal_case.required_suffix = 

dotnet_naming_style.pascal_case.word_separator = 

dotnet_naming_style.pascal_case.capitalization = pascal_case

dotnet_naming_style.begins_with_i.required_prefix = I

dotnet_naming_style.begins_with_i.required_suffix = 

dotnet_naming_style.begins_with_i.word_separator = 

dotnet_naming_style.begins_with_i.capitalization = pascal_case

[*.{cs,vb}]

dotnet_diagnostic.CA1822.severity=silent

dotnet_diagnostic.CA1816.severity=silent

 No newline at end of file

<Project Sdk="Microsoft.NET.Sdk">

	<PropertyGroup>

		<TargetFramework>net8.0-windows</TargetFramework>

		<EnableWindowsTargeting>true</EnableWindowsTargeting>

		<UseWPF>true</UseWPF>

		<ImplicitUsings>enable</ImplicitUsings>

		<Nullable>enable</Nullable>

		<NeutralLanguage>en</NeutralLanguage>

		<PlatformTarget>x64</PlatformTarget>

		<LangVersion>latestmajor</LangVersion>

		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>

		<Title>CodeBeamer</Title>

		<UserSecretsId>f492f7c3-a156-472a-9728-c806d505ebc7</UserSecretsId>

	</PropertyGroup>

	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

		<GenerateDocumentationFile>true</GenerateDocumentationFile>

	</PropertyGroup>

	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

		<DebugType>embedded</DebugType>

	</PropertyGroup>

	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">

		<DebugType>embedded</DebugType>

	</PropertyGroup>

	<ItemGroup>

      <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="6.0.1" />

      <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />

    </ItemGroup>

	<ItemGroup>

		<ProjectReference Include="..\..\Common\Common\Common.csproj" />

	</ItemGroup>

</Project>

using System.Net;

using System.Net.Http;

using System.Net.Http.Headers;

using System.Text;

using Common.Models.Data.Parameter;

using Common.Utilities.Handler;

namespace CodeBeamer.Control;

/// <summary> Class provides the '<see cref="CB"/>' handler, which allows access to the CodeBeamer-ALM-tool for adapting Tracker items.

/// </summary>

public partial class CB : HandlerBase

{

    #region Constants

    /// <summary> Contains the read chunk size as the number of read items.

    /// </summary>

    private const int CHUNK_SIZE = 48;

    #endregion Constants

    #region Fields

    /// <summary> Contains the user name, which is a part of the credentials.

    /// </summary>

    private readonly string _userName;

    /// <summary> Contains the password, which is a part of the credentials.

    /// </summary>

    private readonly string _password;

    /// <summary> Contains the created client instance.

    /// </summary>

    private readonly HttpClient _client;

    #endregion Fields

    #region Constructors

    /// <summary> Constructor initializes all class parameters with assigned parameter values.

    /// </summary>

    /// <param name="timeOut"> The time in seconds to wait, when an access time out occurs (default = 1.0). </param>

    /// <param name="userName"> The username, which is a part of the credentials. </param>

    /// <param name="password"> The password, which is a part of the credentials. </param>

    /// <param name="cancellation"> The cancellation object, allows immediate cancellation of background processes. </param>

    public CB( double timeOut,

               string userName,

               string password,

               Cancellation cancellation ) :

        base( timeOut, cancellation ) {

        this._userName = userName;

        this._password = password;

        this._client = CreateHttpClient();

    }

    #endregion Constructors

    #region Methods

    #region Client

    /// <summary> Creates http client for CodeBeamer connection.

    /// </summary>

    /// <returns> Client. </returns>

    private HttpClient CreateHttpClient() {

        var handler = new HttpClientHandler {

            Proxy = new WebProxy( "http://default-zscaler.iavgroup.local", true ) { },

            UseProxy = true

        };

        var client = new HttpClient( handler );

        ConfigureClient( client );

        return client;

    }

    /// <summary> Add authorization header to http client.

    /// </summary>

    /// <param name="client"> Id of tracker. </param>

    private void ConfigureClient( HttpClient client ) {

        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(

            "Basic", Convert.ToBase64String( Encoding.ASCII.GetBytes( $"{this._userName}:{this._password}" ) ) );

    }

    #endregion Client

    #endregion Methods

}

using CodeBeamer.Models.Tracker;

namespace CodeBeamer.Control;

// The partial implementation of the 'CB' handler, which contains the available services.

public partial class CB

{

    /// <summary> Adds elementary keyword to CodeBeamer.

    /// </summary>

    /// <param name="trackerId"> The unique identification value of the tracker, which needs to be adapted. </param>

    /// <param name="trackerFields"> Keyword Tracker fields, which needs to be created. </param>

    /// <returns> The unique identification value of the created item. </returns>

    public int CreateElementaryKeyWordTrackerItem( int trackerId,

                                                   List<TrackerField> trackerFields ) {

        return AddTrackerItem( trackerId, trackerFields );

    }

    /// <summary> Adds an Syntax element to the CodeBeamer.

    /// </summary>

    /// <param name="trackerId"> The unique identification value of the tracker, which needs to be adapted. </param>

    /// <param name="trackerFields"> Syntax Tracker fields, which needs to be created. </param>

    /// <returns> The unique identification value of the created item. </returns>

    public int CreateSyntaxTrackerItem( int trackerId,

                                        List<TrackerField> trackerFields ) {

        return AddTrackerItem( trackerId, trackerFields );

    }

    /// <summary> Clears the whole Tracker.

    /// </summary>

    /// <param name="trackerId"> Id of tracker. </param>

    /// <returns> 'true', if the operation was successfull. </returns>

    public bool ClearTracker( int trackerId ) {

        int[] trackItemIds = GetAllTrackerItemIds( trackerId );

        foreach ( int id in trackItemIds )

        {

            var requestUrl = $"https://codebeamer.iavgroup.local/cb/api/v3/items/{id}";

            var response = this._client.DeleteAsync( requestUrl ).Result;

            if ( !response.IsSuccessStatusCode )

            {

                Console.WriteLine( $"Error while deleting KeyWord with id: {id}, Response: {response}" );

                return false;

            }

            Thread.Sleep( (int)( this.TimeOut * 1000.0 ) );

        }

        return true;

    }

}