Honor x-accessibility on operations

readme.md

@@ -32,7 +32,8 @@ ___
     - [Rename a client](#rename-a-client)
     - [Replace any generated member](#replace-any-generated-member)
     - [Remove any generated member](#remove-any-generated-member)
-    - [Change model namespace or accessability in bulk](#change-model-namespace-or-accessability-in-bulk)
+    - [Change model namespace or accessibility in bulk](#change-model-namespace-or-accessibility-in-bulk)
+    - [Change operation accessibility in bulk](#change-operation-accessibility-in-bulk)
     - [Exclude models from namespace](#exclude-models-from-namespace)
 
 <!-- /TOC -->
@@ -918,7 +919,7 @@ namespace Azure.Service.Models
 
 </details>
 
-### Change model namespace or accessability in bulk
+### Change model namespace or accessibility in bulk
 
 <details>
 
@@ -964,6 +965,34 @@ directive:
 
 </details>
 
+### Change operation accessibility in bulk
+
+<details>
+
+**Generated code before (Generated/Client.cs):**
+
+``` C#
+public virtual Response Operation(string body = null, CancellationToken cancellationToken = default)
+public virtual async Task<Response> OperationAsync(string body = null, CancellationToken cancellationToken = default)
+```
+
+**Add autorest.md transformation**
+
+```
+directive:
+- from: swagger-document
+  where: $..[?(@.operationId=='Operation')]
+  transform: >
+    $["x-accessibility"] = "internal";
+```
+
+**Generated code after (Generated/Client.cs):**
+
+``` C#
+internal virtual Response Operation(string body = null, CancellationToken cancellationToken = default)
+internal virtual async Task<Response> OperationAsync(string body = null, CancellationToken cancellationToken = default)
+```
+
 ### Exclude models from namespace
 
 <details>

src/AutoRest.CSharp/Common/Generation/Writers/RequestWriterHelpers.cs

@@ -19,15 +19,14 @@ internal static class RequestWriterHelpers
     {
         private static string GetPipeline (bool lowLevel) => lowLevel ? "Pipeline" : "_pipeline";
 
-        public static void WriteRequestCreation(CodeWriter writer, RestClientMethod clientMethod, bool lowLevel)
+        public static void WriteRequestCreation(CodeWriter writer, RestClientMethod clientMethod, bool lowLevel, string methodAccessibility)
         {
             using var methodScope = writer.AmbientScope();
             var parameters = clientMethod.Parameters;
 
             var methodName = CreateRequestMethodName(clientMethod.Name);
             var returnType = lowLevel ? typeof(Azure.Core.Request) : typeof(HttpMessage);
-            var visibility = lowLevel ? "private" : (clientMethod.IsVisible ? "protected" : "internal");
-            writer.Append($"{visibility} {returnType} {methodName}(");
+            writer.Append($"{methodAccessibility} {returnType} {methodName}(");
             foreach (Parameter clientParameter in parameters)
             {
                 if (lowLevel)

src/AutoRest.CSharp/Common/Generation/Writers/RestClientWriter.cs

@@ -98,7 +98,7 @@ private void WriteClientCtor(CodeWriter writer, RestClient restClient, CSharpTyp
 
         private void WriteRequestCreation(CodeWriter writer, RestClientMethod clientMethod)
         {
-            RequestWriterHelpers.WriteRequestCreation (writer, clientMethod, lowLevel: false);
+            RequestWriterHelpers.WriteRequestCreation (writer, clientMethod, lowLevel: false, "internal");
         }
 
         private void WriteOperation(CodeWriter writer, RestClientMethod operation, bool async)

src/AutoRest.CSharp/Common/Input/CodeModelPartials.cs

@@ -23,6 +23,7 @@ internal partial class Operation
         // For some reason, booleans in dictionaries are deserialized as string instead of bool.
         public bool IsLongRunning => Convert.ToBoolean(Extensions.GetValue<string>("x-ms-long-running-operation") ?? "false");
         public string? LongRunningFinalStateVia => Extensions.GetValue<IDictionary<object, object>>("x-ms-long-running-operation-options")?.GetValue<string>("final-state-via");
+        public string? Accessibility => Extensions.GetValue<string>("x-accessibility");
 
         public ServiceResponse LongRunningInitialResponse
         {

src/AutoRest.CSharp/Common/Output/Models/ClientMethod.cs

@@ -7,17 +7,19 @@ namespace AutoRest.CSharp.Output.Models
 {
     internal class ClientMethod
     {
-        public ClientMethod(string name, RestClientMethod restClientMethod, string? description, Diagnostic diagnostics)
+        public ClientMethod(string name, RestClientMethod restClientMethod, string? description, Diagnostic diagnostics, string accessibility)
         {
             Name = name;
             RestClientMethod = restClientMethod;
             Description = description;
             Diagnostics = diagnostics;
+            Accessibility = accessibility;
         }
 
         public string Name { get; }
         public RestClientMethod RestClientMethod { get; }
         public string? Description { get; }
         public Diagnostic Diagnostics { get; }
+        public string Accessibility { get; }
     }
-}
+}

src/AutoRest.CSharp/Common/Output/Models/Requests/PagingMethod.cs

@@ -20,5 +20,6 @@ public PagingMethod(RestClientMethod method, RestClientMethod? nextPageMethod, s
         public RestClientMethod? NextPageMethod { get; }
         public PagingResponseInfo PagingResponse { get; }
         public Diagnostic Diagnostics { get; }
+        public string Accessibility => "public";
     }
 }

src/AutoRest.CSharp/Common/Output/Models/Requests/RestClientMethod.cs

@@ -9,7 +9,7 @@ namespace AutoRest.CSharp.Output.Models.Requests
 {
     internal class RestClientMethod
     {
-        public RestClientMethod(string name, string? description, CSharpType? returnType, Request request, Parameter[] parameters, Response[] responses, DataPlaneResponseHeaderGroupType? headerModel, bool bufferResponse, bool isVisible)
+        public RestClientMethod(string name, string? description, CSharpType? returnType, Request request, Parameter[] parameters, Response[] responses, DataPlaneResponseHeaderGroupType? headerModel, bool bufferResponse, string accessibility)
         {
             Name = name;
             Request = request;
@@ -19,7 +19,7 @@ public RestClientMethod(string name, string? description, CSharpType? returnType
             ReturnType = returnType;
             HeaderModel = headerModel;
             BufferResponse = bufferResponse;
-            IsVisible = isVisible;
+            Accessibility = accessibility;
         }
 
         public string Name { get; }
@@ -30,6 +30,6 @@ public RestClientMethod(string name, string? description, CSharpType? returnType
         public DataPlaneResponseHeaderGroupType? HeaderModel { get; }
         public bool BufferResponse { get; }
         public CSharpType? ReturnType { get; }
-        public bool IsVisible { get; }
+        public string Accessibility { get; }
     }
 }

src/AutoRest.CSharp/Common/Output/Models/RestClient.cs

@@ -88,7 +88,7 @@ protected virtual Dictionary<ServiceRequest, RestClientMethod> EnsureNormalMetho
                     {
                         continue;
                     }
-                    _requestMethods.Add(serviceRequest, Builder.BuildMethod(operation, httpRequest, serviceRequest.Parameters, null, false));
+                    _requestMethods.Add(serviceRequest, Builder.BuildMethod(operation, httpRequest, serviceRequest.Parameters, null, "public"));
                 }
             }
 
@@ -178,7 +178,7 @@ protected static RestClientMethod BuildNextPageMethod(RestClientMethod method, O
                 responses,
                 method.HeaderModel,
                 bufferResponse: true,
-                isVisible: false);
+                accessibility: "internal");
         }
 
         public virtual RestClientMethod? GetNextOperationMethod(ServiceRequest request)

src/AutoRest.CSharp/Common/Output/Models/RestClientBuilder.cs

@@ -61,7 +61,7 @@ private string GetRequestParameterName (RequestParameter requestParameter)
             return requestParameter.Language.Default.SerializedName ?? defaultName;
         }
 
-        public RestClientMethod BuildMethod(Operation operation, HttpRequest httpRequest, IEnumerable<RequestParameter> requestParameters, DataPlaneResponseHeaderGroupType? responseHeaderModel, bool isVisible)
+        public RestClientMethod BuildMethod(Operation operation, HttpRequest httpRequest, IEnumerable<RequestParameter> requestParameters, DataPlaneResponseHeaderGroupType? responseHeaderModel, string accessibility)
         {
             Dictionary<RequestParameter, ConstructedParameter> allParameters = new ();
 
@@ -89,7 +89,7 @@ public RestClientMethod BuildMethod(Operation operation, HttpRequest httpRequest
                 responses,
                 responseHeaderModel,
                 operation.Extensions?.BufferResponse ?? true,
-                isVisible: isVisible
+                accessibility: accessibility
             );
         }
 

src/AutoRest.CSharp/DataPlane/Generation/DataPlaneClientWriter.cs

@@ -76,7 +76,7 @@ private void WriteClientMethod(CodeWriter writer, ClientMethod clientMethod, boo
 
             var methodName = CreateMethodName(clientMethod.Name, async);
             var asyncText = async ? "async" : string.Empty;
-            writer.Append($"public virtual {asyncText} {responseType} {methodName}(");
+            writer.Append($"{clientMethod.Accessibility} virtual {asyncText} {responseType} {methodName}(");
 
             foreach (Parameter parameter in parameters)
             {
@@ -294,7 +294,7 @@ private void WritePagingOperation(CodeWriter writer, PagingMethod pagingMethod,
             writer.WriteXmlDocumentationParameter("cancellationToken", "The cancellation token to use.");
             writer.WriteXmlDocumentationRequiredParametersException(parameters);
 
-            writer.Append($"public virtual {responseType} {CreateMethodName(pagingMethod.Name, async)}(");
+            writer.Append($"{pagingMethod.Accessibility} virtual {responseType} {CreateMethodName(pagingMethod.Name, async)}(");
             foreach (Parameter parameter in parameters)
             {
                 writer.WriteParameter(parameter);
@@ -397,7 +397,7 @@ private void WriteStartOperationOperation(CodeWriter writer, DataPlaneLongRunnin
             writer.WriteXmlDocumentationRequiredParametersException(parameters);
 
             string asyncText = async ? "async " : string.Empty;
-            writer.Append($"public virtual {asyncText}{returnType} {CreateStartOperationName(lroMethod.Name, async)}(");
+            writer.Append($"{lroMethod.Accessibility} virtual {asyncText}{returnType} {CreateStartOperationName(lroMethod.Name, async)}(");
             foreach (Parameter parameter in parameters)
             {
                 writer.WriteParameter(parameter);

src/AutoRest.CSharp/DataPlane/Output/DataPlaneClient.cs

@@ -116,7 +116,8 @@ private IEnumerable<ClientMethod> BuildMethods()
                         name,
                         startMethod,
                         BuilderHelpers.EscapeXmlDescription(operation.Language.Default.Description),
-                        new Diagnostic($"{Declaration.Name}.{name}", Array.Empty<DiagnosticAttribute>()));
+                        new Diagnostic($"{Declaration.Name}.{name}", Array.Empty<DiagnosticAttribute>()),
+                        operation.Accessibility ?? "public");
                 }
             }
         }

src/AutoRest.CSharp/DataPlane/Output/DataPlaneLongRunningOperationMethod.cs

@@ -21,5 +21,6 @@ public DataPlaneLongRunningOperationMethod(string name, DataPlaneLongRunningOper
         public RestClientMethod StartMethod { get; }
 
         public Diagnostic Diagnostics { get; }
+        public string Accessibility => "public";
     }
 }

src/AutoRest.CSharp/DataPlane/Output/DataPlaneRestClient.cs

@@ -46,7 +46,8 @@ protected override Dictionary<ServiceRequest, RestClientMethod> EnsureNormalMeth
                         continue;
                     }
                     var headerModel = _context.Library.FindHeaderModel(operation);
-                    requestMethods.Add(serviceRequest, Builder.BuildMethod(operation, httpRequest, serviceRequest.Parameters, headerModel, false));
+                    var accessibility = operation.Accessibility ?? "public";
+                    requestMethods.Add(serviceRequest, Builder.BuildMethod(operation, httpRequest, serviceRequest.Parameters, headerModel, accessibility));
                 }
             }
 

src/AutoRest.CSharp/LowLevel/Generation/LowLevelClientWriter.cs

@@ -49,7 +49,7 @@ private void WriteClientMethodRequest(CodeWriter writer, RestClientMethod client
             {
                 writer.WriteXmlDocumentationParameter(parameter.Name, parameter.Description);
             }
-            RequestWriterHelpers.WriteRequestCreation(writer, clientMethod, lowLevel: true);
+            RequestWriterHelpers.WriteRequestCreation(writer, clientMethod, lowLevel: true, "private");
         }
 
         private void WriteClientMethod(CodeWriter writer, RestClientMethod clientMethod, bool async)
@@ -68,7 +68,7 @@ private void WriteClientMethod(CodeWriter writer, RestClientMethod clientMethod,
 
             var methodName = CreateMethodName(clientMethod.Name, async);
             var asyncText = async ? "async" : string.Empty;
-            writer.Append($"public virtual {asyncText} {responseType} {methodName}(");
+            writer.Append($"{clientMethod.Accessibility} virtual {asyncText} {responseType} {methodName}(");
 
             foreach (var parameter in parameters)
             {

src/AutoRest.CSharp/LowLevel/Output/LowLevelRestClient.cs

@@ -55,7 +55,8 @@ private IEnumerable<RestClientMethod> BuildAllMethods()
                     // will show up first.
 
                     IEnumerable<RequestParameter> requestParameters = serviceRequest.Parameters.Where (FilterServiceParamaters);
-                    RestClientMethod method = _builder.BuildMethod(operation, (HttpRequest)serviceRequest.Protocol.Http!, requestParameters, null, true);
+                    var accessibility = operation.Accessibility ?? "public";
+                    RestClientMethod method = _builder.BuildMethod(operation, (HttpRequest)serviceRequest.Protocol.Http!, requestParameters, null, accessibility);
                     List<Parameter> parameters = method.Parameters.ToList();
                     RequestBody? body = null;
 
@@ -74,7 +75,7 @@ private IEnumerable<RestClientMethod> BuildAllMethods()
                     }
 
                     Request request = new Request (method.Request.HttpMethod, method.Request.PathSegments, method.Request.Query, method.Request.Headers, body);
-                    yield return new RestClientMethod (method.Name, method.Description, method.ReturnType, request, parameters.ToArray(), method.Responses, method.HeaderModel, method.BufferResponse, method.IsVisible);
+                    yield return new RestClientMethod (method.Name, method.Description, method.ReturnType, request, parameters.ToArray(), method.Responses, method.HeaderModel, method.BufferResponse, method.Accessibility);
                 }
             }
         }

src/AutoRest.CSharp/Properties/launchSettings.json

@@ -1,5 +1,13 @@
 {
   "profiles": {
+    "Accessibility": {
+      "commandName": "Project",
+      "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestProjects\\Accessibility\\Generated"
+    },
+    "Accessibility-LowLevel": {
+      "commandName": "Project",
+      "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestProjects\\Accessibility-LowLevel\\Generated"
+    },
     "additionalProperties": {
       "commandName": "Project",
       "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestServerProjects\\additionalProperties\\Generated"

test/AutoRest.TestServer.Tests/AccessibilityTests.cs

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Linq;
+using System.Reflection;
+using Accessibility_LowLevel;
+using NUnit.Framework;
+
+namespace AutoRest.TestServer.Tests
+{
+    public class AccessibilityTests
+    {
+        [Test]
+        public void AccessibilityHonoredOnOperations()
+        {
+            var client = typeof(AccessibilityClient);
+            Assert.AreEqual(true, client.GetMethod ("Operation").IsPublic, "Operation should be public");
+            Assert.AreEqual(true, client.GetMethod ("OperationAsync").IsPublic, "OperationAsync should be public");
+            Assert.AreEqual(true, client.GetMethod ("OperationInternal", BindingFlags.Instance | BindingFlags.NonPublic).IsAssembly, "OperationInternal should be internal");
+            Assert.AreEqual(true, client.GetMethod ("OperationInternalAsync", BindingFlags.Instance | BindingFlags.NonPublic).IsAssembly, "OperationInternalAsync should be internal");
+        }
+    }
+}

test/AutoRest.TestServerLowLevel.Tests/AccessibilityTests.cs

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Linq;
+using System.Reflection;
+using Accessibility_LowLevel;
+using NUnit.Framework;
+
+namespace AutoRest.TestServer.Tests
+{
+    public class AccessibilityTests
+    {
+        [Test]
+        public void AccessibilityHonoredOnOperations()
+        {
+            var client = typeof(AccessibilityClient);
+            Assert.AreEqual(true, client.GetMethod ("Operation").IsPublic, "Operation should be public");
+            Assert.AreEqual(true, client.GetMethod ("OperationAsync").IsPublic, "OperationAsync should be public");
+            Assert.AreEqual(true, client.GetMethod ("OperationInternal", BindingFlags.Instance | BindingFlags.NonPublic).IsAssembly, "OperationInternal should be internal");
+            Assert.AreEqual(true, client.GetMethod ("OperationInternalAsync", BindingFlags.Instance | BindingFlags.NonPublic).IsAssembly, "OperationInternalAsync should be internal");
+        }
+    }
+}

test/AutoRest.TestServerLowLevel.Tests/AutoRest.TestServerLowLevel.Tests.csproj

@@ -24,6 +24,7 @@
     <Compile Include="../TestServerProjectsLowLevel/**/*.cs" LinkBase="TestServerProjectsLowLevel" />
     <Compile Include="../TestProjectsLowLevel/**/*.cs" LinkBase="TestProjectsLowLevel" />
     <None Include="../TestServerProjectsLowLevel/**/*.yaml" LinkBase="TestServerProjectsLowLevel" />
+    <Compile Include="../TestProjects/**/*.cs" LinkBase="TestProjects" />
 
     <Compile Include="../AutoRest.TestServer.Tests/Infrastructure/*.cs" />
     <Compile Include="../AutoRest.TestServer.Tests/TestConstants.cs" />