feat: добавил unmanaged-deps в module.yaml

13xforever · madetara · commit f917f83296a9 · 2023-04-10T17:21:33.000+03:00
Добавил возможность пометить конфигурацию модуля чтобы не править зависимости
Конфигурация пропускается при вызове ref fix если есть флаг unmanaged-deps
Пример:
```yaml
my-config:
  unmanaged-deps: true
  deps:
    - dep1
    - dep2
```
diff --git a/docs/README-module.yaml.md b/docs/README-module.yaml.md
@@ -9,169 +9,184 @@ Each configuration may include the following sections:
 - build
 - install/artifacts
 
-Configurations may be inherited in order to avoid repeating of dependencies information.
+Configurations may be inherited to avoid repeating of dependencies information.
 
 A module shall contain configuration `full-build`, including all the others, if possible. It will be used while execution of the following commands `cm get` and `cm build`.
 
 Optional configuration `default` can contain default build and deps sections.
 
 Example:
-
-    # configuration description section client
-    client:
-      # list of dependencies of client configuration
-      # dependencies are listed in the following form: <moduleName>[@branchName][/configName]
-      # kanso – reference to kanso module
-      # kanso/client – reference to kanso in client configuration
-      # kanso@develop/client - kanso from develop branch in client configuration
-      # '@' and '/' marks in branch name should be shielded by '\'
-      deps:
-        - core
-        - log4net
-        - nunit
-        - logging
-        - http
-        - http.rp
-        - topology
-        # to prefer current branch in deps
-        - force: $CURRENT_BRANCH
-        # or use <moduleName>@$CURRENT_BRANCH to prefer current branch in some module;
-        # you can also choose any specific branch name in deps:
-        # - force: mybestbranch
-        # or provide a comma-separated list of preferred branches:
-        # - force: mybestbranch,notsogoodbranch,leastfavoritebranch
-        # master branch is always the default option if all forced branches are missing
-
-      # information on build of the present module in the present configuration
-      build:
-        # build solution Kontur.Drive.sln in Client configuration
-        target: Kontur.Drive.sln
-        configuration: Client
-
-      # Information on results of the present configuration build
-      install:
-        - bin/Kontur.Drive.Client.dll
-        - bin/Kontur.Drive.ServiceModel.dll
-        # For operation of Kontur.Drive.Client.dll you need a reference on logging module build
-        - module logging
-        # Or a reference on nuget bundle
-        - nuget Newtonsoft.Json/6.0.8
-
-    # Configuration sdk "expands" configuration client (> client)
-    # and is a configuration at default (*default) (it is used at referencing on this module)
-    sdk > client *default:
-      # in order to avoid repetition of dependencies lists
-      # deps from client are inherited here and you have no need to state them once again
-      deps:
-        - auth
-        - libfront
-        - zebra
-        - kanso
-        - upload-service
-        - access-control
-        - zebra-utils
-        - config
-        - zookeeper
-
-      # Section build is NOT inherited
-      build:
-        target: Kontur.Drive.sln
-        configuration: Sdk
-
-      # Section install is inherited, so you need to add only missing binaries
-      install:
-        - Kontur.Drive.TestHost/bin/Release/Kontur.Drive.TestHost.exe
-        - Kontur.Drive.TestHost/bin/Release/ServiceStack.Interfaces.dll
-      # DLL files that can be used by other modules,
-      # but are ignored while running cm ref add
-      artifacts:
-        - Kontur.Drive.TestHost/bin/Release/SomeOther.dll
-
-
-    # Configuration full-build expands client and sdk
-    full-build > client, sdk:
-      deps:
-        # So you state diff on deps (in configuration full-build kanso/full-build is used.
-        # At first, we “delete” kanso from dependencies, then add kanso/full-build)
-        - -kanso
-        - kanso/full-build
-
-      build:
-        target: Kontur.Drive.sln
-        configuration: Release
-
+```yaml
+# configuration description section client
+client:
+  # list of dependencies of client configuration
+  # dependencies are listed in the following form: <moduleName>[@branchName][/configName]
+  # kanso – reference to kanso module
+  # kanso/client – reference to kanso in client configuration
+  # kanso@develop/client - kanso from develop branch in client configuration
+  # '@' and '/' marks in branch name should be shielded by '\'
+  deps:
+    - core
+    - log4net
+    - nunit
+    - logging
+    - http
+    - http.rp
+    - topology
+    # to prefer current branch in deps
+    - force: $CURRENT_BRANCH
+    # or use <moduleName>@$CURRENT_BRANCH to prefer current branch in some module;
+    # you can also choose any specific branch name in deps:
+    # - force: mybestbranch
+    # or provide a comma-separated list of preferred branches:
+    # - force: mybestbranch,notsogoodbranch,leastfavoritebranch
+    # master branch is always the default option if all forced branches are missing
+
+  # information on build of the present module in the present configuration
+  build:
+    # build solution Kontur.Drive.sln in Client configuration
+    target: Kontur.Drive.sln
+    configuration: Client
+
+  # Information on results of the present configuration build
+  install:
+    - bin/Kontur.Drive.Client.dll
+    - bin/Kontur.Drive.ServiceModel.dll
+    # For operation of Kontur.Drive.Client.dll you need a reference on logging module build
+    - module logging
+    # Or a reference on nuget bundle
+    - nuget Newtonsoft.Json/6.0.8
+
+# Configuration sdk "expands" configuration client (> client)
+# and is a configuration at default (*default) (it is used at referencing on this module)
+sdk > client *default:
+  # in order to avoid repetition of dependencies lists
+  # deps from client are inherited here and you have no need to state them once again
+  deps:
+    - auth
+    - libfront
+    - zebra
+    - kanso
+    - upload-service
+    - access-control
+    - zebra-utils
+    - config
+    - zookeeper
+
+  # Section build is NOT inherited
+  build:
+    target: Kontur.Drive.sln
+    configuration: Sdk
+
+  # Section install is inherited, so you need to add only missing binaries
+  install:
+    - Kontur.Drive.TestHost/bin/Release/Kontur.Drive.TestHost.exe
+    - Kontur.Drive.TestHost/bin/Release/ServiceStack.Interfaces.dll
+  # DLL files that can be used by other modules,
+  # but are ignored while running cm ref add
+  artifacts:
+    - Kontur.Drive.TestHost/bin/Release/SomeOther.dll
+
+
+# Configuration full-build expands client and sdk
+full-build > client, sdk:
+  deps:
+    # So, you state diff on deps (in configuration full-build kanso/full-build is used.
+    # At first, we “delete” kanso from dependencies, then add kanso/full-build)
+    - -kanso
+    - kanso/full-build
+
+  build:
+    target: Kontur.Drive.sln
+    configuration: Release
+```
 
 # build section
 
 #### For a module which does not need to be built:
-
-    build:
-      target: None
-      configuration: None
+```yaml
+build:
+  target: None
+  configuration: None
+```
 
 #### If it is necessary to state additional parameters:
-
-    build:
-      # A statement of build target
-      target: Solution.sln
-      tool:
-        # An assembling tool. msbuild - for MSBuild.exe at Windows and xbuild at *nix. dotnet - for new .NET Core
-        name: msbuild
-        # msbuild version, the latest at default
-        version: "14.0"
-        # set VS150COMNTOOLS=D:\Program Files\Microsoft Visual Studio\2017\Professional\Common7\Tools\
-      # Solution configuration
-      configuration: Release
-      # You can state your parameters here. Default parameters are not used.
-      # Quotation marks in parameters are shielded by '\'.
-      # Default parameters for msbuild:
-      # /t:Rebuild /nodeReuse:false /maxcpucount /v:m /p:WarningLevel=0 /p:VisualStudioVersion=14.0 (if not stated)
-      parameters: "/p:WarningLevel=0"
+```yaml
+build:
+  # A statement of build target
+  target: Solution.sln
+  tool:
+    # An assembling tool. msbuild - for MSBuild.exe at Windows and xbuild at *nix. dotnet - for new .NET Core
+    name: msbuild
+    # msbuild version, the latest at default
+    version: "14.0"
+    # set VS150COMNTOOLS=D:\Program Files\Microsoft Visual Studio\2017\Professional\Common7\Tools\
+  # Solution configuration
+  configuration: Release
+  # You can state your parameters here. Default parameters are not used.
+  # Quotation marks in parameters are shielded by '\'.
+  # Default parameters for msbuild:
+  # /t:Rebuild /nodeReuse:false /maxcpucount /v:m /p:WarningLevel=0 /p:VisualStudioVersion=14.0 (if not stated)
+  parameters: "/p:WarningLevel=0"
+```
 
 #### If there are several solutions in a module
-
-    build:
-      - name: a.release             # You shall name each part
-        target: a.sln
-        configuration: release
-      - name: b.debug
-        target: b.sln
-        configuration: debug
+```yaml
+build:
+  - name: a.release             # You shall name each part
+    target: a.sln
+    configuration: release
+  - name: b.debug
+    target: b.sln
+    configuration: debug
+```
 
 #### Build with custom script:
-
 build.xproj:
-
-    <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-        <Target Name="Rebuild">
-            <Exec Command="ping google.com > 1.txt" />
-        </Target>
-    </Project>
+```xml
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+    <Target Name="Rebuild">
+        <Exec Command="ping google.com > 1.txt" />
+    </Target>
+</Project>
+```
 
 module.yaml:
-
-    full-build:
-      deps:
-      build:
-        target: build.xproj
-        configuration: Release
+```yaml
+full-build:
+  deps:
+  build:
+    target: build.xproj
+    configuration: Release
+```
 
 # Git hooks
+```yaml
+default:                  # Description in a default configuration
+  hooks:
+    - myhooks/pre-push    # A way to a hook in a repository
+                          # will be copied to <module_name>/.git/hooks
+    # A hook inbuilt into pre-commit will check that files containing non-ASCII symbols have UTF-8 with BOM coding
+    - pre-commit.cement
 
-    default:                  # Description in a default configuration
-      hooks:
-        - myhooks/pre-push    # A way to a hook in a repository
-                              # will be copied to <module_name>/.git/hooks
-        # A hook inbuilt into pre-commit will check that files containing non-ASCII symbols have UTF-8 with BOM coding
-        - pre-commit.cement
-
-    full-build *default:      # Other module configurations
-
+full-build *default:      # Other module configurations
+```
 
 If there is a hook in a present branch, then it is not deleted when you switch to another branch.
 If you want to use your hook with pre-commit.cement, just add its call-out into your hook
-
-    .git/hooks/pre-commit.cement
-    if [ $? -ne 0 ]; then
-      exit 1
-    fi
+```sh
+.git/hooks/pre-commit.cement
+if [ $? -ne 0 ]; then
+  exit 1
+fi
+```
+
+# Advanced configuration
+#### Excluding specific config from dependency management
+In case it is undesirable to have specific configuration being automatically updated with `cm ref add`/`cm ref fix` commands, it is possible to mark such a section with `unmanaged-deps` flag
+```yaml
+special:
+  unmanaged-deps: true
+  deps:
+    - mylib
+```
diff --git a/src/Cement.Cli.Commands/RefFixCommand.cs b/src/Cement.Cli.Commands/RefFixCommand.cs
@@ -71,8 +71,19 @@ private void Fix(bool fixExternal)
 
         var modules = Helper.GetModules();
 
-        var configs = Yaml.ConfigurationParser(rootModuleName).GetConfigurations();
-        var buildsInfo = configs.SelectMany(config => Yaml.BuildParser(rootModuleName).Get(config));
+        var configYamlParser = Yaml.ConfigurationParser(rootModuleName);
+        var configs = configYamlParser.GetConfigurations();
+        var buildsInfo = new List<BuildData>();
+        foreach (var config in configs)
+        {
+            var props = configYamlParser.GetConfigurationDescription(config);
+            if (props is {Count: > 0}
+                && props.TryGetValue(DepsPatcherProject.SkipConfigurationFlagName, out var v)
+                && v is true)
+                continue;
+
+            buildsInfo.AddRange(Yaml.BuildParser(rootModuleName).Get(config));
+        }
         var processedFiles = new HashSet<string>();
 
         foreach (var buildInfo in buildsInfo)
diff --git a/src/Cement.Cli.Common/DepsPatcherProject.cs b/src/Cement.Cli.Common/DepsPatcherProject.cs
@@ -18,6 +18,8 @@ public sealed class DepsPatcherProject
     private readonly ConsoleWriter consoleWriter;
     private readonly IDepsValidatorFactory depsValidatorFactory;
 
+    public const string SkipConfigurationFlagName = "unmanaged-deps";
+
     public DepsPatcherProject(ILogger<DepsPatcherProject> logger, ConsoleWriter consoleWriter,
                               IDepsValidatorFactory depsValidatorFactory)
     {
@@ -122,11 +124,18 @@ private static List<string> GetUsedCementConfigsForProject(string modulePath, st
         if (!File.Exists(moduleYaml))
             return new List<string>();
 
+        var configYamlParser = new ConfigurationYamlParser(new FileInfo(modulePath));
         var configurations = new ConfigurationParser(new FileInfo(modulePath)).GetConfigurations();
         var result = new HashSet<string>();
 
         foreach (var config in configurations)
         {
+            var props = configYamlParser.GetConfigurationDescription(config);
+            if (props is {Count: > 0}
+                && props.TryGetValue(SkipConfigurationFlagName, out var v)
+                && v is true)
+                continue;
+
             var buildData = new BuildYamlParser(new FileInfo(modulePath)).Get(config);
             foreach (var data in buildData)
             {
diff --git a/src/Cement.Cli.Common/YamlParsers/ConfigurationYamlParser.cs b/src/Cement.Cli.Common/YamlParsers/ConfigurationYamlParser.cs
@@ -35,6 +35,13 @@ public IList<string> GetConfigurations()
             .ToList();
     }
 
+    public Dictionary<string, object> GetConfigurationDescription(string configName)
+    {
+        return configurationsDescription.TryGetValue(configName, out var result)
+            ? (result as Dictionary<object, object>)?.ToDictionary(k =>(string)k.Key, v => v.Value)
+            : null;
+    }
+
     public bool ConfigurationExists(string configName)
     {
         return configurationsDescription.Keys.Select(GetRealConfigurationName).Contains(configName);
diff --git a/tests/Cement.Cli.Tests/ParsersTests/TestConfigurationYamlParser.cs b/tests/Cement.Cli.Tests/ParsersTests/TestConfigurationYamlParser.cs

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,13 @@ public IList<string> GetConfigurations()`
`35`	`35`	`.ToList();`
`36`	`36`	`}`
`37`	`37`
	`38`	`+ public Dictionary<string, object> GetConfigurationDescription(string configName)`
	`39`	`+ {`
	`40`	`+ return configurationsDescription.TryGetValue(configName, out var result)`
	`41`	`+ ? (result as Dictionary<object, object>)?.ToDictionary(k =>(string)k.Key, v => v.Value)`
	`42`	`+ : null;`
	`43`	`+ }`
	`44`	`+`
`38`	`45`	`public bool ConfigurationExists(string configName)`
`39`	`46`	`{`
`40`	`47`	`return configurationsDescription.Keys.Select(GetRealConfigurationName).Contains(configName);`