Allow unmocked (#58)

* added allowUnmocked to base classes

* added allowUnmocked to moctokit

* updated script and autogenerated endpoint-requests

* bumped version

* updated readme

README.md

@@ -7,7 +7,7 @@ Using this library along with [kiegroup/act-js](https://github.com/kiegroup/act-
 ## Table of Content
 
 - [Moctokit](#moctokit)
-  - [Specifying which base url to use](#specifying-which-base-url-to-use)
+  - [Initialization options](#initialization-options)
   - [Mock an api](#mock-an-api)
     - [Mock the entire endpoint](#mock-the-entire-endpoint)
     - [Mock an endpoint for specific parameter(s)](#mock-an-endpoint-for-specific-parameters)
@@ -43,7 +43,7 @@ mock.rest.repos
   .reply({ status: 200, data: { full_name: "it worked" } });
 ```
 
-### Specifying which base url to use
+### Initialization options
 
 By default a moctokit instance uses `https://api.github.com` as the base url
 
@@ -57,6 +57,12 @@ You can also specify a base url when a creating a new instance. Useful when you
 const moctokit = new Moctokit("http://localhost:8000"); // mocks github apis for http://localhost:8000
 ```
 
+You can enable other APIs to pass through if there is no exact match  
+
+```typescript
+const moctokit = new Moctokit(undefined, true); // mocks github apis for https://api.github.com and lets unmatched apis to pass through
+```
+
 ### Mock an api
 
 You can mock all the github api exactly how [@octokit/rest](https://octokit.github.io/rest.js/v19) library is used to make an actual call to the corresponding api.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kie/mock-github",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A bunch of tools to configure and create a local github environment to test your github actions in without having to clutter your github with test repositories, actions or hitting github api rate limits.",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",

scripts/endpoint-requests.js

@@ -42,21 +42,21 @@ async function generateEndpointRequest() {
 
     newEndpointRequest[scope][
       endpoint.id
-    ] = `new MoctokitRequestMocker<"${path}", "${method}">(baseUrl, endpoints["${scope}"]["${endpoint.id}"]).request`;
+    ] = `new MoctokitRequestMocker<"${path}", "${method}">(baseUrl, endpoints["${scope}"]["${endpoint.id}"], allowUnmocked).request`;
   });
   const content = prettier
     .format(
       `import {MoctokitRequestMocker} from "@mg/moctokit/request/request-mocker";
     import endpoints from "./endpoint-details";
-     const endpointToMethod = (baseUrl: string) => (${JSON.stringify(
+     const endpointToMethod = (baseUrl: string, allowUnmocked = false) => (${JSON.stringify(
        newEndpointRequest
      )})
 
     export default endpointToMethod`,
       { parser: "typescript" }
     )
     .replace(
-      /('|")(new MoctokitRequestMocker<.+>\(baseUrl, endpoints\[.+\]\[.+\]\).request)('|")/g,
+      /('|")(new MoctokitRequestMocker<.+>\(baseUrl, endpoints\[.+\]\[.+\], allowUnmocked\).request)('|")/g,
       "$2"
     );
 

src/endpoint-mocker/request/abstract-request-mocker.ts

@@ -4,10 +4,12 @@ import { EndpointDetails, Params } from "@mg/endpoint-mocker/endpoint-mocker.typ
 export abstract class RequestMocker {
   private _endpointDetails: EndpointDetails;
   private _baseUrl: string;
+  private _allowUnmocked: boolean;
 
-  constructor(baseUrl: string, endpointDetails: EndpointDetails) {
+  constructor(baseUrl: string, endpointDetails: EndpointDetails, allowUnmocked = false) {
     this._endpointDetails = endpointDetails;
     this._baseUrl = baseUrl;
+    this._allowUnmocked = allowUnmocked;
   }
 
   get baseUrl() {
@@ -18,6 +20,10 @@ export abstract class RequestMocker {
     return this._endpointDetails;
   }
 
+  get allowUnmocked() {
+    return this._allowUnmocked;
+  }
+
   protected parseParams(params?: Params) {
     const { pathParams, query, requestBody } = this.extractParams(params);
 

src/endpoint-mocker/response/abstract-response-mocker.ts

@@ -15,9 +15,10 @@ export abstract class ResponseMocker<T, S extends number> {
     path: string | RegExp,
     method: string,
     query?: DataMatcherMap,
-    requestBody?: DataMatcherMap
+    requestBody?: DataMatcherMap,
+    allowUnmocked = false
   ) {
-    this.scope = nock(baseUrl);
+    this.scope = nock(baseUrl, { allowUnmocked });
     this.responses = [];
     this.path = path;
     this.query = query;

src/moctokit/moctokit.ts

@@ -2,8 +2,8 @@ import endpointToMethod from "@mg/moctokit/generated/endpoint-request";
 
 export class Moctokit {
   private _rest;
-  constructor(baseUrl?: string) {
-    this._rest = endpointToMethod(baseUrl ?? "https://api.github.com");
+  constructor(baseUrl?: string, allowUnmocked = false) {
+    this._rest = endpointToMethod(baseUrl ?? "https://api.github.com", allowUnmocked);
   }
 
   get rest() {

src/moctokit/request/request-mocker.ts

@@ -8,8 +8,9 @@ export class MoctokitRequestMocker<
   Path extends keyof paths,
   Method extends keyof paths[Path]
 > extends RequestMocker {
-  constructor(baseUrl: string, endpointDetails: EndpointDetails) {
-    super(baseUrl, endpointDetails);
+
+  constructor(baseUrl: string, endpointDetails: EndpointDetails, allowUnmocked = false) {
+    super(baseUrl, endpointDetails, allowUnmocked);
 
     // need to bind the instance context to the function. otherwise it is lost during endpointToMethod generation
     this.request = this.request.bind(this);
@@ -22,7 +23,8 @@ export class MoctokitRequestMocker<
       path,
       this.endpointDetails.method,
       query,
-      requestBody
+      requestBody,
+      this.allowUnmocked
     );
   }
 }