Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
85404f1
inital changes in directives parser
BobSilent Aug 5, 2019
1cdb4a8
provide impersonation in workitemstore
BobSilent Sep 2, 2019
857d27f
beautify rulewrapper
BobSilent Sep 2, 2019
e0ff521
Parse impersonation directive from rulecode
BobSilent Sep 3, 2019
d5e0506
move azure function context to function handler
BobSilent Sep 4, 2019
4451313
update documentation and add possibility to configuring a rule or a m…
BobSilent Sep 4, 2019
dd57402
extend tests
BobSilent Sep 5, 2019
646cf1b
minor fix RuleFileParser
BobSilent Sep 5, 2019
66b83c2
RuleMapping display impersonation configuration in list command
BobSilent Sep 6, 2019
b8e6122
align code and revert GetInvocationUrl changes
BobSilent Sep 7, 2019
731bc69
simplify AzureFunctionHandler and add intial test for bogus test message
BobSilent Sep 11, 2019
098918b
fix: RevisedBy not set, use ChangedBy of workitem
BobSilent Sep 10, 2019
d597418
reduce compiler messages
BobSilent Sep 8, 2019
06fd870
improve logging for batch request handling
BobSilent Sep 12, 2019
e139379
Refactor RuleWrapper and RuleEngine to follow single responsibility p…
BobSilent Sep 8, 2019
1c49df1
Show impersonation information when listing rules therefore changed s…
BobSilent Sep 8, 2019
5e6f591
Add possibility to impersonate when adding or updating a rule
BobSilent Sep 14, 2019
fa7aeb9
fix: Display disabled rules, see ea9d05f5c5b77a66d09908ee88cc5d3e8f3f…
BobSilent Sep 15, 2019
4d3ea36
Change Impersonation Configuration
BobSilent Sep 16, 2019
cc0a905
update for #85 Strip directives by commenting out rather than omitting
BobSilent Dec 20, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions doc/command-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ This is the last step: gluing Azure DevOps to the Rule hosted in Azure Functions

```Batchfile
map.rule --verbose --project SampleProject --event workitem.created --instance my1 --rule test1
map.rule --verbose --project SampleProject --event workitem.updated --instance my1 --rule test2
map.rule --verbose --project SampleProject --event workitem.updated --instance my1 --rule test2 --impersonate
map.rule --verbose --project SampleProject --event workitem.created --instance my3 --resourceGroup myRG1 --rule test3
```
The same rule can be triggered by multiple events from different Azure DevOps projects. Currently only these events are supported:
Expand All @@ -82,13 +82,29 @@ list.mappings --instance my1 --project SampleProject
```


### Disable and enable rules
Disabling a broken rule leaves any mappings in place.
### Configuring rules

Configuring a rule leaves any mappings in place.

#### Disable and enable rules

e.g. disabling a broken rule
```Batchfile
configure.rule --verbose --instance my1 --name test1 --disable
configure.rule --verbose --instance my1 --name test1 --enable
```

#### Execute Impersonated

configure a rule to run impersonated
**Attention:** To use this the identify accessing Azure DevOps needs special permissions,
see [Rule Examples](setup.md#azure-devops-personal-access-token--PAT-).

```Batchfile
configure.rule --verbose --instance my1 --name test1 --disableImpersonate
configure.rule --verbose --instance my1 --name test1 --enableImpersonate
```


### Update the code and runtime of a rule
This command updates the code and potentially the Aggregator runtime
Expand Down
14 changes: 12 additions & 2 deletions doc/rule-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ They are parsed by Aggregator and removed before compiling the code.
`.lang=C#`
`.language=Csharp`

Currently the only supported language is C#. You can use the `.lang` directive to specify the programming language used by the rule.
Currently the only supported language is C#.
You can use the `.lang` directive to specify the programming language used by the rule.
If no language is specified: C# is default.

## reference directive
Loads the specified assembly in the Rule execution context
Expand All @@ -19,8 +21,16 @@ Example
Equivalent to C# namespace
`.import=System.Collections.Generic`

## impersonate directive
Aggregator uses credentials for accessing Azure DevOps. By default the changes which
were saved back to Azure DevOps are done with the credentials provided for accessing
Azure DevOps.
In order to do the changes on behalf of the account who initiated an event, which Aggregator is going to handle,
specify
`.impersonate=onBehalfOfInitiator`


**Attention:** To use this the identify accessing Azure DevOps needs special permissions,
see [Rule Examples](setup.md#azure-devops-personal-access-token--PAT-).


# WorkItem Object
Expand Down
11 changes: 9 additions & 2 deletions doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,15 @@ In Azure Portal you can check the permissons in the IAM menu for the selected Re

## Azure DevOps Personal Access Token (PAT)

A PAT has the same or less permissions than the person that creates it.
We recommend that the PAT is issued by an Azure DevOps Organization Administrator.
A PAT has the same or less permissions than the person/identity that creates it.
We recommend that the PAT is issued by an Azure DevOps Organization Administrator Identity.

When using the [impersonate directive](rule-language.md#impersonate-directive),
[mapping a rule](command-examples.md#adds-two-service-hooks-to-azure-devops--each-invoking-a-different-rule)
to execute impersonated or
[configuring a rule impersonated](command-examples.md#),
the used identity for creating the PAT must have the permission:
"Bypass rules on work item updates"

Aggregator needs the following Scopes:

Expand Down
197 changes: 197 additions & 0 deletions src/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
# Remove the line below if you want to inherit .editorconfig settings from higher directories
root = true

# C# files
[*.cs]

#### Core EditorConfig Options ####

# Indentation and spacing
indent_size = 4
indent_style = space
tab_width = 4

# New line preferences
end_of_line = crlf
insert_final_newline = false

#### .NET Coding Conventions ####

# Organize usings
dotnet_separate_import_directive_groups = false
dotnet_sort_system_directives_first = false

# this. and Me. preferences
dotnet_style_qualification_for_event = false:silent
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_property = false:silent

# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent

# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent

# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent

# Expression-level preferences
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_throw_expression = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_object_initializer = true:suggestion
dotnet_style_prefer_auto_properties = true:suggestion
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion

# Field preferences
dotnet_style_readonly_field = true:suggestion

# Parameter preferences
dotnet_code_quality_unused_parameters = all:suggestion

#### C# Coding Conventions ####

# var preferences
csharp_style_var_elsewhere = false:silent
csharp_style_var_for_built_in_types = false:silent
csharp_style_var_when_type_is_apparent = false:silent

# Expression-bodied members
csharp_style_expression_bodied_accessors = true:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_lambdas = true:silent
csharp_style_expression_bodied_local_functions = false:silent
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_operators = false:silent
csharp_style_expression_bodied_properties = true:silent

# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_prefer_switch_expression = true:suggestion

# Null-checking preferences
csharp_style_conditional_delegate_call = true:suggestion

# Modifier preferences
csharp_prefer_static_local_function = true:suggestion
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async

# Code-block preferences
csharp_prefer_braces = true:warning
csharp_prefer_simple_using_statement = false:silent

# Expression-level preferences
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_pattern_local_over_anonymous_function = true:suggestion
csharp_style_prefer_index_operator = true:suggestion
csharp_style_prefer_range_operator = true:suggestion
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:silent

# 'using' directive preferences
csharp_using_directive_placement = outside_namespace:suggestion

#### C# Formatting Rules ####

# New line preferences
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 = all
csharp_new_line_between_query_expression_clauses = true

# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = true
csharp_indent_labels = no_change
csharp_indent_switch_labels = true

# Space preferences
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 = false
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 = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false

# Wrapping preferences
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = true

#### Naming styles ####

# Naming rules

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 = suggestion
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 = suggestion
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

# Symbol specifications

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 =

# Naming styles

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
7 changes: 7 additions & 0 deletions src/aggregator-cli.sln
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,15 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "unittests-ruleng", "unittes
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{020591FD-B34A-49E6-98E5-D8DD2A838997}"
ProjectSection(SolutionItems) = preProject
.editorconfig = .editorconfig
..\azure-pipelines-CI.yaml = ..\azure-pipelines-CI.yaml
..\azure-pipelines-Release.yaml = ..\azure-pipelines-Release.yaml
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "unittests-core", "unittests-core\unittests-core.csproj", "{6AD42A49-2EA4-4659-855D-0C011D368794}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "unittests-function", "unittests-function\unittests-function.csproj", "{A875638A-8E95-47BE-AEDD-BAD5113692B3}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -69,6 +72,10 @@ Global
{6AD42A49-2EA4-4659-855D-0C011D368794}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6AD42A49-2EA4-4659-855D-0C011D368794}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6AD42A49-2EA4-4659-855D-0C011D368794}.Release|Any CPU.Build.0 = Release|Any CPU
{A875638A-8E95-47BE-AEDD-BAD5113692B3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{A875638A-8E95-47BE-AEDD-BAD5113692B3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{A875638A-8E95-47BE-AEDD-BAD5113692B3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{A875638A-8E95-47BE-AEDD-BAD5113692B3}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
41 changes: 41 additions & 0 deletions src/aggregator-cli/AzureBaseClass.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
using System.Threading;
using System.Threading.Tasks;

using Microsoft.Azure.Management.AppService.Fluent;
using Microsoft.Azure.Management.Fluent;


namespace aggregator.cli {
internal abstract class AzureBaseClass
{
protected IAzure _azure;

protected ILogger _logger;

protected AzureBaseClass(IAzure azure, ILogger logger)
{
_azure = azure;
_logger = logger;
}


protected async Task<IWebApp> GetWebApp(InstanceName instance, CancellationToken cancellationToken)
{
var webFunctionApp = await _azure
.AppServices
.WebApps
.GetByResourceGroupAsync(
instance.ResourceGroupName,
instance.FunctionAppName, cancellationToken);
cancellationToken.ThrowIfCancellationRequested();
return webFunctionApp;
}


protected KuduApi GetKudu(InstanceName instance)
{
var kudu = new KuduApi(instance, _azure, _logger);
return kudu;
}
}
}
Loading