Add variables with scope

NGitLab.Mock/Clients/GroupVariableClient.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using NGitLab.Models;
 
 namespace NGitLab.Mock.Clients;
@@ -18,17 +19,37 @@ public GroupVariableClient(ClientContext context, GroupId groupId)
 
     public IEnumerable<Variable> All => throw new NotImplementedException();
 
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public Variable Create(VariableCreate model)
     {
         throw new NotImplementedException();
     }
 
-    public void Delete(string key)
+    public Variable Create(Variable model)
     {
         throw new NotImplementedException();
     }
 
-    public Variable Update(string key, VariableUpdate model)
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public void Delete(string key) => Delete(key, null);
+
+    public void Delete(string key, string environmentScope)
+    {
+        throw new NotImplementedException();
+    }
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public Variable Update(string key, VariableUpdate model) => Update(key, model, null);
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public Variable Update(string key, VariableUpdate model, string environmentScope)
+    {
+        throw new NotImplementedException();
+    }
+
+    public Variable Update(string key, Variable model) => Update(key, model, null);
+
+    public Variable Update(string key, Variable model, string environmentScope)
     {
         throw new NotImplementedException();
     }

NGitLab.Mock/Clients/ProjectVariableClient.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using NGitLab.Models;
 
 namespace NGitLab.Mock.Clients;
@@ -18,17 +19,37 @@ public ProjectVariableClient(ClientContext context, ProjectId projectId)
 
     public IEnumerable<Variable> All => throw new NotImplementedException();
 
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public Variable Create(VariableCreate model)
     {
         throw new NotImplementedException();
     }
 
-    public void Delete(string key)
+    public Variable Create(Variable model)
     {
         throw new NotImplementedException();
     }
 
-    public Variable Update(string key, VariableUpdate model)
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public void Delete(string key) => Delete(key, null);
+
+    public void Delete(string key, string environmentScope)
+    {
+        throw new NotImplementedException();
+    }
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public Variable Update(string key, VariableUpdate model) => Update(key, model, null);
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public Variable Update(string key, VariableUpdate model, string environmentScope)
+    {
+        throw new NotImplementedException();
+    }
+
+    public Variable Update(string key, Variable model) => Update(key, model, null);
+
+    public Variable Update(string key, Variable model, string environmentScope)
     {
         throw new NotImplementedException();
     }

NGitLab.Tests/GroupVariableClientTests.cs

@@ -1,7 +1,9 @@
 using System.Linq;
+using System.Net;
 using System.Threading.Tasks;
 using NGitLab.Models;
 using NGitLab.Tests.Docker;
+using NuGet.Versioning;
 using NUnit.Framework;
 
 namespace NGitLab.Tests;
@@ -52,4 +54,64 @@ public async Task Test_group_variables()
         variables = groupVariableClient.All.ToList();
         Assert.That(variables, Has.Count.EqualTo(3));
     }
+
+    [Test]
+    [NGitLabRetry]
+    public async Task Test_group_variables_with_complete_members()
+    {
+        using var context = await GitLabTestContext.CreateAsync();
+        var group = context.CreateGroup();
+        var groupVariableClient = context.Client.GetGroupVariableClient(group.Id);
+
+        // Create
+        var variable = groupVariableClient.Create(new Variable
+        {
+            Key = "My_Key",
+            Value = "My value",
+            Description = "Some important variable",
+            Protected = true,
+            Type = VariableType.Variable,
+            Masked = false,
+            Raw = false,
+        });
+
+        Assert.That(variable.Key, Is.EqualTo("My_Key"));
+        Assert.That(variable.Value, Is.EqualTo("My value"));
+
+        if (context.IsGitLabVersionInRange(VersionRange.Parse("[16.2,)"), out _))
+        {
+            Assert.That(variable.Description, Is.EqualTo("Some important variable"));
+        }
+
+        Assert.That(variable.Protected, Is.EqualTo(true));
+        Assert.That(variable.Type, Is.EqualTo(VariableType.Variable));
+        Assert.That(variable.Masked, Is.EqualTo(false));
+        Assert.That(variable.Raw, Is.EqualTo(false));
+
+        // Update
+        var newScope = "integration/*";
+        variable = groupVariableClient.Update(variable.Key,
+            new Variable { Value = "My value edited", Protected = false, EnvironmentScope = newScope},
+            variable.EnvironmentScope);
+
+        Assert.That(variable.Key, Is.EqualTo("My_Key"));
+        Assert.That(variable.Value, Is.EqualTo("My value edited"));
+        Assert.That(variable.Protected, Is.EqualTo(false));
+
+        // Delete
+        var ex = Assert.Throws<GitLabException>(() => groupVariableClient.Delete(variable.Key, "wrongScope"));
+        Assert.That(ex!.StatusCode == HttpStatusCode.NotFound);
+
+        groupVariableClient.Delete(variable.Key);
+
+        var variables = groupVariableClient.All.ToList();
+        Assert.That(variables, Is.Empty);
+
+        // All
+        groupVariableClient.Create(new Variable { Key = "Variable1", Value = "test", EnvironmentScope = "test/*" });
+        groupVariableClient.Create(new Variable { Key = "Variable2", Value = "test", EnvironmentScope = "integration" });
+        groupVariableClient.Create(new Variable { Key = "Variable3", Value = "test", EnvironmentScope = "*" });
+        variables = groupVariableClient.All.ToList();
+        Assert.That(variables, Has.Count.EqualTo(3));
+    }
 }

NGitLab.Tests/ProjectVariableClientTests.cs

@@ -1,7 +1,10 @@
 using System.Linq;
+using System.Net;
 using System.Threading.Tasks;
+using NGitLab.Extensions;
 using NGitLab.Models;
 using NGitLab.Tests.Docker;
+using NuGet.Versioning;
 using NUnit.Framework;
 
 namespace NGitLab.Tests;
@@ -52,4 +55,139 @@ public async Task Test_project_variables()
         variables = projectVariableClient.All.ToList();
         Assert.That(variables, Has.Count.EqualTo(3));
     }
+
+    [Test]
+    [NGitLabRetry]
+    public async Task Test_project_variables_with_scope()
+    {
+        using var context = await GitLabTestContext.CreateAsync();
+        var project = context.CreateProject();
+        var projectVariableClient = context.Client.GetProjectVariableClient(project.Id);
+
+        // Create
+        var variable = projectVariableClient.Create(new Variable
+        {
+            Key = "My_Key",
+            Value = "My value",
+            Description = "Some important variable",
+            Protected = true,
+            Type = VariableType.Variable,
+            Masked = false,
+            Raw = false,
+            EnvironmentScope = "test/*",
+        });
+
+        Assert.That(variable.Key, Is.EqualTo("My_Key"));
+        Assert.That(variable.Value, Is.EqualTo("My value"));
+
+        if (context.IsGitLabVersionInRange(VersionRange.Parse("[16.2,)"), out _))
+        {
+            Assert.That(variable.Description, Is.EqualTo("Some important variable"));
+        }
+
+        Assert.That(variable.Protected, Is.EqualTo(true));
+        Assert.That(variable.Type, Is.EqualTo(VariableType.Variable));
+        Assert.That(variable.Masked, Is.EqualTo(false));
+        Assert.That(variable.Raw, Is.EqualTo(false));
+        Assert.That(variable.EnvironmentScope, Is.EqualTo("test/*"));
+
+        // Update
+        var newScope = "integration/*";
+        variable = projectVariableClient.Update(variable.Key, new Variable
+        {
+            Value = "My value edited",
+            Protected = false,
+            EnvironmentScope = newScope,
+        },
+        variable.EnvironmentScope);
+
+        Assert.That(variable.Key, Is.EqualTo("My_Key"));
+        Assert.That(variable.Value, Is.EqualTo("My value edited"));
+        Assert.That(variable.Protected, Is.EqualTo(false));
+        Assert.That(variable.EnvironmentScope, Is.EqualTo(newScope));
+
+        // Delete
+        var ex = Assert.Throws<GitLabException>(() => projectVariableClient.Delete(variable.Key, "wrongScope"));
+        Assert.That(ex!.StatusCode == HttpStatusCode.NotFound);
+
+        projectVariableClient.Delete(variable.Key, newScope);
+
+        var variables = projectVariableClient.All.ToList();
+        Assert.That(variables, Is.Empty);
+
+        // All
+        projectVariableClient.Create(new Variable { Key = "Variable1", Value = "test", EnvironmentScope = "test/*" });
+        projectVariableClient.Create(new Variable { Key = "Variable2", Value = "test", EnvironmentScope = "integration" });
+        projectVariableClient.Create(new Variable { Key = "Variable3", Value = "test", EnvironmentScope = "*" });
+        variables = projectVariableClient.All.ToList();
+        Assert.That(variables, Has.Count.EqualTo(3));
+    }
+
+    [Test]
+    [NGitLabRetry]
+    public async Task Test_matching_scoped_variables()
+    {
+        using var context = await GitLabTestContext.CreateAsync();
+        var project = context.CreateProject();
+        var projectVariableClient = context.Client.GetProjectVariableClient(project.Id);
+
+        // Create variable for test environment
+        projectVariableClient.Create(new Variable
+        {
+            Key = "My_Key",
+            Value = "My value",
+            Description = "Variable for test environments",
+            Protected = true,
+            Type = VariableType.Variable,
+            Masked = false,
+            Raw = false,
+            EnvironmentScope = "test/*",
+        });
+
+        // Create variable for test environment
+        var variableForIntegration = projectVariableClient.Create(new Variable
+        {
+            Key = "My_Key",
+            Value = "My value",
+            Description = "Variable for integration environments",
+            Protected = true,
+            Type = VariableType.Variable,
+            Masked = false,
+            Raw = false,
+            EnvironmentScope = "integration/*",
+        });
+
+        var specificEnvironment = "integration/datacenter-105-left";
+        var variablesForSpecificEnvironment = projectVariableClient.All.Where(v => v.IsMatchForEnvironment(specificEnvironment));
+
+        Assert.That(variablesForSpecificEnvironment.Count(), Is.EqualTo(1));
+    }
+
+    [Test]
+    [NGitLabRetry]
+    public void Test_standalone_matching_scoped_variables()
+    {
+        var variable = new Variable
+        {
+            Key = "My_Key",
+            Value = "My value",
+            Description = "Some important variable",
+            Protected = true,
+            Type = VariableType.Variable,
+            Masked = false,
+            Raw = false,
+            EnvironmentScope = "test/*",
+        };
+
+        Assert.That(variable.IsMatchForEnvironment("test/"), Is.True);
+        Assert.That(variable.IsMatchForEnvironment("test/123"), Is.True);
+        Assert.That(variable.IsMatchForEnvironment("integration"), Is.False);
+
+        // Change to simple scope
+        variable.EnvironmentScope = "test";
+
+        Assert.That(variable.IsMatchForEnvironment("test"), Is.True);
+        Assert.That(variable.IsMatchForEnvironment("integration"), Is.False);
+        Assert.That(variable.IsMatchForEnvironment("integration/abc"), Is.False);
+    }
 }

NGitLab/Extensions/VariableExtensions.cs

@@ -0,0 +1,21 @@
+using System.Text.RegularExpressions;
+using NGitLab.Models;
+
+#pragma warning disable MA0009 // Add regex evaluation timeout
+
+namespace NGitLab.Extensions;
+
+public static class VariableExtensions
+{
+    public static bool IsMatchForEnvironment(this Variable variable, string environment)
+    {
+        var sqlStyleLike = variable.EnvironmentScope.Replace('*', '%').Replace('?', '_');
+
+        if (string.IsNullOrEmpty(environment))
+            return false; // or throw exception if source == null
+        if (string.IsNullOrEmpty(sqlStyleLike))
+            return false; // or throw exception if like == null
+
+        return Regex.IsMatch(environment, "^" + Regex.Escape(sqlStyleLike).Replace("_", ".").Replace("%", ".*") + "$");
+    }
+}

NGitLab/IProjectBadgeClient.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using System.ComponentModel;
 using NGitLab.Models;
 
 namespace NGitLab;
@@ -28,11 +29,22 @@ public interface IProjectVariableClient
 
     Variable this[string key] { get; }
 
+    [EditorBrowsable(EditorBrowsableState.Never)]
     Variable Create(VariableCreate model);
 
+    Variable Create(Variable model);
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
     Variable Update(string key, VariableUpdate model);
 
+    Variable Update(string key, Variable model);
+
+    Variable Update(string key, Variable model, string environmentScope);
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
     void Delete(string key);
+
+    void Delete(string key, string environmentScope);
 }
 
 public interface IGroupVariableClient
@@ -43,7 +55,17 @@ public interface IGroupVariableClient
 
     Variable Create(VariableCreate model);
 
+    Variable Create(Variable model);
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
     Variable Update(string key, VariableUpdate model);
 
+    Variable Update(string key, Variable model);
+
+    Variable Update(string key, Variable model, string environmentScope);
+
+    [EditorBrowsable(EditorBrowsableState.Never)]
     void Delete(string key);
+
+    void Delete(string key, string environmentScope);
 }