@typespec/http-specs 0.37.2

package/specs/encode/bytes/main.tsp

@@ -0,0 +1,369 @@
+import "@typespec/http";
+import "@typespec/spec-lib";
+
+using TypeSpec.Http;
+using Azure.ClientGenerator.Core;
+
+@doc("Test for encode decorator on bytes.")
+@supportedBy("dpg")
+@scenarioService("/encode/bytes")
+namespace Encode.Bytes;
+
+@encode(BytesKnownEncoding.base64url)
+scalar base64urlBytes extends bytes;
+
+@operationGroup
+@route("/query")
+namespace Query {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (base64) for bytes query parameter.
+    Expected query parameter:
+    value=dGVzdA== (base64 encode of test)
+    """)
+  op default(
+    @query
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64")
+  @scenario
+  @scenarioDoc("""
+    Test base64 encode for bytes query parameter.
+    Expected query parameter:
+    value=dGVzdA== (base64 encode of test)
+    """)
+  op base64(
+    @query
+    @encode(BytesKnownEncoding.base64)
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64url")
+  @scenario
+  @scenarioDoc("""
+    Test base64url encode for bytes query parameter.
+    Expected query parameter:
+    value=dGVzdA (base64url encode of test)
+    """)
+  op base64url(
+    @query
+    @encode(BytesKnownEncoding.base64url)
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64url-array")
+  @scenario
+  @scenarioDoc("""
+    Test base64url encode for bytes array query parameter.
+    Expected query parameter:
+    value=dGVzdA, dGVzdA
+    """)
+  op base64urlArray(
+    #suppress "deprecated" "Deprecated in next release"
+    @query({
+      format: "csv",
+    })
+    value: base64urlBytes[],
+  ): NoContentResponse;
+}
+
+model DefaultBytesProperty {
+  value: bytes;
+}
+
+model Base64BytesProperty {
+  @encode(BytesKnownEncoding.base64)
+  value: bytes;
+}
+
+model Base64urlBytesProperty {
+  @encode(BytesKnownEncoding.base64url)
+  value: bytes;
+}
+
+model Base64urlArrayBytesProperty {
+  value: base64urlBytes[];
+}
+
+@operationGroup
+@route("/property")
+namespace Property {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains bytes properties with default encode (base64).
+    Expected request body:
+    ```json
+    {
+      "value": "dGVzdA==" // base64 encode of test
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "dGVzdA=="
+    }
+    ```
+    """)
+  @post
+  op default(@body body: DefaultBytesProperty): DefaultBytesProperty;
+
+  @route("/base64")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains bytes properties with base64 encode.
+    Expected request body:
+    ```json
+    {
+      "value": "dGVzdA==" // base64 encode of test
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "dGVzdA=="
+    }
+    ```
+    """)
+  @post
+  op base64(@body body: Base64BytesProperty): Base64BytesProperty;
+
+  @route("/base64url")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains bytes properties with base64url encode.
+    Expected request body:
+    ```json
+    {
+      "value": "dGVzdA" // base64url encode of test
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "dGVzdA"
+    }
+    ```
+    """)
+  @post
+  op base64url(@body body: Base64urlBytesProperty): Base64urlBytesProperty;
+
+  @route("/base64url-array")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains bytes array properties with base64url encode.
+    Expected request body:
+    ```json
+    {
+      "value": ["dGVzdA", "dGVzdA"]
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": ["dGVzdA", "dGVzdA"]
+    }
+    ```
+    """)
+  @post
+  op base64urlArray(@body body: Base64urlArrayBytesProperty): Base64urlArrayBytesProperty;
+}
+
+@operationGroup
+@route("/header")
+namespace Header {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (base64) for bytes header.
+    Expected header:
+    value=dGVzdA== (base64 encode of test)
+    """)
+  op default(
+    @header
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64")
+  @scenario
+  @scenarioDoc("""
+    Test base64 encode for bytes header.
+    Expected header:
+    value=dGVzdA== (base64 encode of test)
+    """)
+  op base64(
+    @header
+    @encode(BytesKnownEncoding.base64)
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64url")
+  @scenario
+  @scenarioDoc("""
+    Test base64url encode for bytes header.
+    Expected header:
+    value=dGVzdA (base64url encode of test)
+    """)
+  op base64url(
+    @header
+    @encode(BytesKnownEncoding.base64url)
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64url-array")
+  @scenario
+  @scenarioDoc("""
+    Test base64url encode for bytes array header.
+    Expected header:
+    value=dGVzdA,dGVzdA
+    """)
+  op base64urlArray(
+    @header({
+      format: "csv",
+    })
+    value: base64urlBytes[],
+  ): NoContentResponse;
+}
+
+@operationGroup
+@route("/body/request")
+namespace RequestBody {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (base64) for bytes in a json body.
+    Expected body:
+    "dGVzdA==" (base64 encode of test, in JSON string)
+    """)
+  @post
+  op default(
+    @body
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/octet-stream")
+  @scenario
+  @scenarioDoc("""
+    When content type is application/octet-stream and body is `bytes` the payload is a binary file.
+    File should match packages/cadl-ranch-specs/assets/image.png
+    """)
+  @post
+  op octetStream(
+    @header
+    contentType: "application/octet-stream",
+
+    @body
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/custom-content-type")
+  @scenario
+  @scenarioDoc("""
+    When content type is a custom type(image/png here) and body is `bytes` the payload is a binary file.
+    File should match packages/cadl-ranch-specs/assets/image.png
+    """)
+  @post
+  op customContentType(
+    @header
+    contentType: "image/png",
+
+    @body
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64")
+  @scenario
+  @scenarioDoc("""
+    Test base64 encode for bytes body.
+    Expected body:
+    "dGVzdA==" (base64 encode of test, in JSON string)
+    """)
+  @post
+  op base64(
+    @body
+    @encode(BytesKnownEncoding.base64)
+    value: bytes,
+  ): NoContentResponse;
+
+  @route("/base64url")
+  @scenario
+  @scenarioDoc("""
+    Test base64url encode for bytes body.
+    Expected body:
+    "dGVzdA" (base64url encode of test, in JSON string)
+    """)
+  @post
+  op base64url(
+    @body
+    @encode(BytesKnownEncoding.base64url)
+    value: bytes,
+  ): NoContentResponse;
+}
+
+@operationGroup
+@route("/body/response")
+namespace ResponseBody {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (base64) for bytes in a json body.
+    Expected body:
+    "dGVzdA==" (base64 encode of test, in JSON string)
+    """)
+  op default(): {
+    @body
+    value: bytes;
+  };
+
+  @route("/octet-stream")
+  @scenario
+  @scenarioDoc("""
+    When content type is application/octet-stream and body is `bytes` the payload is a binary file.
+    File should match packages/cadl-ranch-specs/assets/image.png
+    """)
+  op octetStream(): {
+    @header
+    contentType: "application/octet-stream";
+
+    @body
+    value: bytes;
+  };
+
+  @route("/custom-content-type")
+  @scenario
+  @scenarioDoc("""
+    When content type is a custom type(image/png here) and body is `bytes` the payload is a binary file.
+    File should match packages/cadl-ranch-specs/assets/image.png
+    """)
+  op customContentType(): {
+    @header
+    contentType: "image/png";
+
+    @body
+    value: bytes;
+  };
+
+  @route("/base64")
+  @scenario
+  @scenarioDoc("""
+    Test base64 encode for bytes body.
+    Expected body:
+    "dGVzdA==" (base64 encode of test, in JSON string)
+    """)
+  op base64(): {
+    @body
+    @encode(BytesKnownEncoding.base64)
+    value: bytes;
+  };
+
+  @route("/base64url")
+  @scenario
+  @scenarioDoc("""
+    Test base64url encode for bytes body.
+    Expected body:
+    "dGVzdA" (base64url encode of test, in JSON string)
+    """)
+  op base64url(): base64urlBytes;
+}

package/specs/encode/bytes/mockapi.ts

@@ -0,0 +1,309 @@
+import { resolvePath } from "@typespec/compiler";
+import {
+  CollectionFormat,
+  json,
+  MockRequest,
+  passOnSuccess,
+  ScenarioMockApi,
+} from "@typespec/spec-api";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+
+const root = resolvePath(fileURLToPath(import.meta.url), "../../../../../");
+
+const pngFile = readFileSync(resolvePath(root, "assets/image.png"));
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+function createQueryServerTests(
+  uri: string,
+  data: any,
+  value: any,
+  collectionFormat?: CollectionFormat,
+) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      params: data,
+    },
+    response: {
+      status: 204,
+    },
+    handler: (req: MockRequest) => {
+      req.expect.containsQueryParam("value", value, collectionFormat);
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_Query_default = createQueryServerTests(
+  "/encode/bytes/query/default",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Query_base64 = createQueryServerTests(
+  "/encode/bytes/query/base64",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Query_base64url = createQueryServerTests(
+  "/encode/bytes/query/base64url",
+  {
+    value: "dGVzdA",
+  },
+  "dGVzdA",
+);
+Scenarios.Encode_Bytes_Query_base64urlArray = createQueryServerTests(
+  "/encode/bytes/query/base64url-array",
+  {
+    value: ["dGVzdA", "dGVzdA"].join(","),
+  },
+  ["dGVzdA", "dGVzdA"],
+  "csv",
+);
+function createPropertyServerTests(uri: string, data: any, value: any) {
+  return passOnSuccess({
+    uri,
+    method: "post",
+    request: {
+      body: data,
+    },
+    response: {
+      status: 200,
+    },
+    handler: (req: MockRequest) => {
+      req.expect.coercedBodyEquals({ value: value });
+      return {
+        status: 200,
+        body: json({ value: value }),
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_Property_default = createPropertyServerTests(
+  "/encode/bytes/property/default",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Property_base64 = createPropertyServerTests(
+  "/encode/bytes/property/base64",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Property_base64url = createPropertyServerTests(
+  "/encode/bytes/property/base64url",
+  {
+    value: "dGVzdA",
+  },
+  "dGVzdA",
+);
+Scenarios.Encode_Bytes_Property_base64urlArray = createPropertyServerTests(
+  "/encode/bytes/property/base64url-array",
+  {
+    value: ["dGVzdA", "dGVzdA"],
+  },
+  ["dGVzdA", "dGVzdA"],
+);
+function createHeaderServerTests(uri: string, data: any, value: any) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      headers: data,
+    },
+    response: {
+      status: 204,
+    },
+    handler: (req: MockRequest) => {
+      req.expect.containsHeader("value", value);
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_Header_default = createHeaderServerTests(
+  "/encode/bytes/header/default",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Header_base64 = createHeaderServerTests(
+  "/encode/bytes/header/base64",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Header_base64url = createHeaderServerTests(
+  "/encode/bytes/header/base64url",
+  {
+    value: "dGVzdA",
+  },
+  "dGVzdA",
+);
+Scenarios.Encode_Bytes_Header_base64urlArray = createHeaderServerTests(
+  "/encode/bytes/header/base64url-array",
+  {
+    value: ["dGVzdA", "dGVzdA"].join(","),
+  },
+  ["dGVzdA", "dGVzdA"].join(","),
+);
+function createRequestBodyServerTests(
+  uri: string,
+  data: any,
+  headersData: any,
+  value: any,
+  contentType: string = "application/json",
+) {
+  return passOnSuccess({
+    uri,
+    method: "post",
+    request: {
+      body: data,
+      headers: headersData,
+    },
+    response: {
+      status: 204,
+    },
+    handler(req: MockRequest) {
+      req.expect.containsHeader("content-type", contentType);
+      req.expect.rawBodyEquals(value);
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_RequestBody_default = createRequestBodyServerTests(
+  "/encode/bytes/body/request/default",
+  '"dGVzdA=="',
+  {
+    "Content-Type": "application/json",
+  },
+  '"dGVzdA=="',
+);
+Scenarios.Encode_Bytes_RequestBody_base64 = createRequestBodyServerTests(
+  "/encode/bytes/body/request/base64",
+  '"dGVzdA=="',
+  {
+    "Content-Type": "application/json",
+  },
+  '"dGVzdA=="',
+);
+Scenarios.Encode_Bytes_RequestBody_base64url = createRequestBodyServerTests(
+  "/encode/bytes/body/request/base64url",
+  '"dGVzdA=="',
+  {
+    "Content-Type": "application/json",
+  },
+  '"dGVzdA=="',
+);
+
+Scenarios.Encode_Bytes_RequestBody_customContentType = createRequestBodyServerTests(
+  "/encode/bytes/body/request/custom-content-type",
+  pngFile,
+  {
+    "Content-Type": "image/png",
+  },
+  pngFile,
+  "image/png",
+);
+Scenarios.Encode_Bytes_RequestBody_octetStream = createRequestBodyServerTests(
+  "/encode/bytes/body/request/octet-stream",
+  pngFile,
+  {
+    "Content-Type": "application/octet-stream",
+  },
+  pngFile,
+  "application/octet-stream",
+);
+function createResponseBodyServerTests(
+  uri: string,
+  data: any,
+  headerData: any,
+  value: any,
+  contentType: string = "application/json",
+) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      headers: headerData,
+    },
+    response: {
+      status: 200,
+      body: {
+        contentType: contentType,
+        rawContent: data,
+      },
+    },
+    handler(req: MockRequest) {
+      return {
+        status: 200,
+        body: {
+          contentType: contentType,
+          rawContent: value,
+        },
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_ResponseBody_default = createResponseBodyServerTests(
+  "/encode/bytes/body/response/default",
+  JSON.stringify("dGVzdA=="),
+  {
+    "Content-Type": "application/json",
+  },
+  JSON.stringify("dGVzdA=="),
+);
+Scenarios.Encode_Bytes_ResponseBody_base64 = createResponseBodyServerTests(
+  "/encode/bytes/body/response/base64",
+  JSON.stringify("dGVzdA=="),
+  {
+    "Content-Type": "application/json",
+  },
+  JSON.stringify("dGVzdA=="),
+);
+Scenarios.Encode_Bytes_ResponseBody_base64url = createResponseBodyServerTests(
+  "/encode/bytes/body/response/base64url",
+  JSON.stringify("dGVzdA"),
+  {
+    "Content-Type": "application/json",
+  },
+  JSON.stringify("dGVzdA"),
+);
+Scenarios.Encode_Bytes_ResponseBody_customContentType = createResponseBodyServerTests(
+  "/encode/bytes/body/response/custom-content-type",
+  pngFile,
+  {
+    "Content-Type": "image/png",
+  },
+  pngFile,
+  "image/png",
+);
+Scenarios.Encode_Bytes_ResponseBody_octetStream = createResponseBodyServerTests(
+  "/encode/bytes/body/response/octet-stream",
+  pngFile,
+  {
+    "Content-Type": "application/octet-stream",
+  },
+  pngFile,
+  "application/octet-stream",
+);