rule: adminUsername-should-not-be-literal (#4702)

* rule: adminUsername-should-not-be-literal

* Check compile errors in all linter tests

* PR comments

* Update test baselines

* Fix file casing

* Fix completion tests

* Update test baselines

Co-authored-by: Stephen Weatherford <stephen.weatherford@microsoft.com>
Co-authored-by: Bicep Automation <bicep@noreply.github.com>

docs/examples/bicepconfig.json

@@ -2,6 +2,9 @@
   "analyzers": {
     "core": {
       "rules": {
+        "adminusername-should-not-be-literal": {
+          "level": "warning"
+        },
         "no-hardcoded-env-urls": {
           "level": "warning"
         },
@@ -23,4 +26,4 @@
       }
     }
   }
-}
+}

docs/linter-rules/adminusername-should-not-be-literal.md

@@ -0,0 +1,51 @@
+# AdminUserName should not be a literal
+
+**Code**: adminUsername-should-not-be-literal
+
+**Description**: When setting an adminUserName property, don't use a literal value or an expression which evaluates to a literal value.
+Create a parameter for the username and use an expression to reference the parameter's value.
+
+The following examples fail this test.
+
+```bicep
+resource vm 'Microsoft.Compute/virtualMachines@2020-12-01' = {
+  name: 'name'
+  location: location
+  properties: {
+    osProfile: {
+      adminUsername: 'adminUsername'
+    }
+  }
+}
+```
+
+```bicep
+var defaultAdmin = 'administrator'
+
+resource vm 'Microsoft.Compute/virtualMachines@2020-12-01' = {
+  name: 'name'
+  location: location
+  properties: {
+    osProfile: {
+      adminUsername: defaultAdmin
+    }
+
+```
+
+The following example passes this test.
+
+```bicep
+@secure()
+param adminUsername string
+param location string
+
+resource vm 'Microsoft.Compute/virtualMachines@2020-12-01' = {
+  name: 'name'
+  location: location
+  properties: {
+    osProfile: {
+      adminUsername: adminUsername
+    }
+  }
+}
+```

src/Bicep.Core.UnitTests/Diagnostics/BicepConfigSchemaTests.cs

@@ -74,6 +74,7 @@ public void RuleConfigs_ShouldBeCorrectlyDefined()
                     },
 
                 */
+
                 var allOf = rule!.SelectToken("allOf");
                 Assert.IsNotNull(allOf, "Each rule should have a top-level allOf");
                 allOf.Count().Should().BeGreaterOrEqualTo(2);
@@ -88,5 +89,17 @@ public void RuleConfigs_ShouldBeCorrectlyDefined()
                 refString.Should().Be("#/definitions/rule", "each rule's last allOf should be a ref to the definition of a rule");
             }
         }
+
+        [TestMethod]
+        public void RuleConfigs_RuleNamesShouldUseCorrectCasing()
+        {
+            var (rules, schema) = GetRulesAndSchema();
+            var ruleConfigs = schema.SelectToken("properties.analyzers.properties.core.properties.rules.properties")!.ToObject<IDictionary<string, JObject>>();
+            Assert.IsNotNull(ruleConfigs);
+            foreach (var (key, rule) in ruleConfigs)
+            {
+                key.Should().MatchRegex("^[a-z][a-z-]*[a-z]$", "all rule keys should be lower-cased with hyphens, not start or end with hyphen");
+            }
+        }
     }
 }

src/Bicep.Core.UnitTests/Diagnostics/LinterAnalyzerTests.cs

@@ -35,6 +35,7 @@ public void HasBuiltInRules()
         [DataRow(SecureParameterDefaultRule.Code)]
         [DataRow(SimplifyInterpolationRule.Code)]
         [DataRow(NoUnusedVariablesRule.Code)]
+        [DataRow(AdminUsernameShouldNotBeLiteralRule.Code)]
         public void BuiltInRulesExist(string ruleCode)
         {
             var linter = new LinterAnalyzer(configuration);