ibm-cloud-sdk-core 4.3.3 → 5.0.1

package/lib/sdk-test-helpers.js

@@ -1,102 +0,0 @@
-"use strict";
-/**
- * (C) Copyright IBM Corp. 2019, 2022.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expectToBePromise = exports.getOptions = exports.checkForSuccessfulExecution = exports.checkUserHeader = exports.checkMediaHeaders = exports.checkUrlAndMethod = void 0;
-var expect_1 = __importDefault(require("expect"));
-/**
- * This module provides a set of helper methods used to reduce code duplication in the generated unit tests
- * for the SDKs that depend on this core package. Note that these methods are not used by the tests for this
- * package - they are meant to be exported and made available to dependent libraries.
- */
-/**
- * Takes the request options constructed by the SDK and checks that the `url` and `method` properties
- * were set to their correct values.
- *
- * @param options - the options object put together by the SDK, retrieved from the createRequest mock
- * @param url - The URL path of the service endpoint, from the paths section of the API definition
- * @param method - The HTTP method for the request, from the API definition
- */
-function checkUrlAndMethod(options, url, method) {
-    (0, expect_1.default)(options.url).toEqual(url);
-    (0, expect_1.default)(options.method).toEqual(method);
-}
-exports.checkUrlAndMethod = checkUrlAndMethod;
-/**
- * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call,
- * and checks for the expected values for `Accept` and `Content-Type`. This to verify that the SDK sets
- * the correct values in the code.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param accept - the expected value for the `Accept` header
- * @param contentType - the expected value for the `Content-Type` header
- */
-function checkMediaHeaders(createRequestMock, accept, contentType) {
-    var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
-    (0, expect_1.default)(headers.Accept).toEqual(accept);
-    (0, expect_1.default)(headers['Content-Type']).toEqual(contentType);
-}
-exports.checkMediaHeaders = checkMediaHeaders;
-/**
- * Takes the mock object for the `createRequest` method, extracts the headers that were sent with the call,
- * and checks for the expected value for a user-defined header. This is verify that the SDK accepts header
- * parameters and sends them as headers in the request.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @param userHeaderName - the name of the header passed by the user, e.g. `Contained-Content-Type`
- * @param userHeaderValue - the expected value for the header passed by the user
- */
-function checkUserHeader(createRequestMock, userHeaderName, userHeaderValue) {
-    var headers = createRequestMock.mock.calls[0][0].defaultOptions.headers;
-    (0, expect_1.default)(headers[userHeaderName]).toEqual(userHeaderValue);
-}
-exports.checkUserHeader = checkUserHeader;
-/**
- * This method simply ensures that the method executed without any issues by extracting
- * the argument from the mock object for the `createRequest` method and verifying that it is an object.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- */
-function checkForSuccessfulExecution(createRequestMock) {
-    var sdkParams = createRequestMock.mock.calls[0][0];
-    (0, expect_1.default)(typeof sdkParams).toEqual('object');
-}
-exports.checkForSuccessfulExecution = checkForSuccessfulExecution;
-/**
- * This method extracts the `options` property from the object passed into `createRequest`. This property is
- * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
- * This method is just a convenience method for the unit tests to be able to make assertions on the items in the request.
- *
- * @param createRequestMock - the jest mock object for the `createRequest` method in the `RequestWrapper` class
- * @returns Object
- */
-function getOptions(createRequestMock) {
-    return createRequestMock.mock.calls[0][0].options;
-}
-exports.getOptions = getOptions;
-/**
- * This method simply ensures that the SDK methods return Promises by checking for
- * the `then` function - common way to assess whether or not an object is a Promise.
- *
- * @param sdkPromise - the Promise returned by an SDK method
- */
-function expectToBePromise(sdkPromise) {
-    (0, expect_1.default)(typeof sdkPromise.then).toBe('function');
-}
-exports.expectToBePromise = expectToBePromise;