Merge pull request #2 from fussybeaver/ND-add-wiremock

Add wiremock and github action

Author: Niel Drummond

.github/workflows/default.yml

@@ -0,0 +1,62 @@
+on: [push, pull_request]
+
+name: Default
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Run cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --all-features
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+
+    services:
+      wiremock:
+        image: rodolpheche/wiremock
+        ports: 
+          - 8080:8080
+        options: --name wiremock -v ${{ github.workspace }}/tests/stubs:/home/wiremock
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+        with:
+          path: 'checkout'
+
+      - name: Move files
+        run: sudo apt-get update && sudo apt-get install -y rsync && sudo rsync -avu checkout/ ./ && sudo chown -R 1001 .
+
+      - name: Restart wiremock
+        uses: docker://docker
+        with:
+          args: docker restart wiremock
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Run cargo test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test 
+          args: --features isahc,mercy,squirrel-girl,inertia,starfox,mock --target x86_64-unknown-linux-gnu

Cargo.lock

@@ -41,6 +41,9 @@ switcheroo = []
 wyandotte = []
 zzzax = []
 
+# Activate mock base url
+mock = []
+
 [dependencies]
 base64 = "0.13"
 chrono = { version = "0.4", features = ["serde"] }

Cargo.toml

@@ -1,5 +1,6 @@
 [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![docs](https://docs.rs/roctogen/badge.svg)](https://docs.rs/roctogen/)
+[![GitHub workflow](https://github.com/github/docs/actions/workflows/default.yml/badge.svg)](https://github.com/fussybeaver/roctogen/actions/workflows/default.yml)
 
 ## Roctogen: a rust client library for the GitHub v3 API
 
@@ -21,6 +22,44 @@ roctogen = "0.1.0"
 
 [API docs](https://docs.rs/roctogen/latest).
 
+[Endpoints](https://docs.rs/roctogen/latest/roctogen/endpoints/index.html).
+
+Supported endpoints:
+---
+
+  - [Meta](https://docs.rs/roctogen/latest/roctogen/endpoints/meta/struct.Meta.html)
+  - [Issues](https://docs.rs/roctogen/latest/roctogen/endpoints/issues/struct.Issues.html)
+  - [Licenses](https://docs.rs/roctogen/latest/roctogen/endpoints/licenses/struct.Licenses.html)
+  - [Reactions](https://docs.rs/roctogen/latest/roctogen/endpoints/reactions/struct.Reactions.html)
+  - [Activity](https://docs.rs/roctogen/latest/roctogen/endpoints/activity/struct.Activity.html)
+  - [Projects](https://docs.rs/roctogen/latest/roctogen/endpoints/projects/struct.Projects.html)
+  - [Orgs](https://docs.rs/roctogen/latest/roctogen/endpoints/orgs/struct.Orgs.html)
+  - [Users](https://docs.rs/roctogen/latest/roctogen/endpoints/users/struct.Users.html)
+  - [Apps](https://docs.rs/roctogen/latest/roctogen/endpoints/apps/struct.Apps.html)
+  - [AuditLog](https://docs.rs/roctogen/latest/roctogen/endpoints/audit_log/struct.AuditLog.html)
+  - [RateLimit](https://docs.rs/roctogen/latest/roctogen/endpoints/rate_limit/struct.RateLimit.html)
+  - [Repos](https://docs.rs/roctogen/latest/roctogen/endpoints/repos/struct.Repos.html)
+  - [SecretScanning](https://docs.rs/roctogen/latest/roctogen/endpoints/secret_scanning/struct.SecretScanning.html)
+  - [Packages](https://docs.rs/roctogen/latest/roctogen/endpoints/packages/struct.Packages.html)
+  - [Search](https://docs.rs/roctogen/latest/roctogen/endpoints/search/struct.Search.html)
+  - [Teams](https://docs.rs/roctogen/latest/roctogen/endpoints/teams/struct.Teams.html)
+  - [Markdown](https://docs.rs/roctogen/latest/roctogen/endpoints/markdown/struct.Markdown.html)
+  - [OauthAuthorizations](https://docs.rs/roctogen/latest/roctogen/endpoints/oauth_authorizations/struct.OauthAuthorizations.html)
+  - [Actions](https://docs.rs/roctogen/latest/roctogen/endpoints/actions/struct.Actions.html)
+  - [Migrations](https://docs.rs/roctogen/latest/roctogen/endpoints/migrations/struct.Migrations.html)
+  - [Gists](https://docs.rs/roctogen/latest/roctogen/endpoints/gists/struct.Gists.html)
+  - [CodesOfConduct](https://docs.rs/roctogen/latest/roctogen/endpoints/codes_of_conduct/struct.CodesOfConduct.html)
+  - [Pulls](https://docs.rs/roctogen/latest/roctogen/endpoints/pulls/struct.Pulls.html)
+  - [Gitignore](https://docs.rs/roctogen/latest/roctogen/endpoints/gitignore/struct.Gitignore.html)
+  - [EnterpriseAdmin](https://docs.rs/roctogen/latest/roctogen/endpoints/enterprise_admin/struct.EnterpriseAdmin.html)
+  - [Git](https://docs.rs/roctogen/latest/roctogen/endpoints/git/struct.Git.html)
+  - [Scim](https://docs.rs/roctogen/latest/roctogen/endpoints/scim/struct.Scim.html)
+  - [CodeScanning](https://docs.rs/roctogen/latest/roctogen/endpoints/code_scanning/struct.CodeScanning.html)
+  - [Checks](https://docs.rs/roctogen/latest/roctogen/endpoints/checks/struct.Checks.html)
+  - [Billing](https://docs.rs/roctogen/latest/roctogen/endpoints/billing/struct.Billing.html)
+  - [Interactions](https://docs.rs/roctogen/latest/roctogen/endpoints/interactions/struct.Interactions.html)
+  - [Emojis](https://docs.rs/roctogen/latest/roctogen/endpoints/emojis/struct.Emojis.html)
+
 ## Usage
 
 A quick example of this library:
@@ -97,7 +136,7 @@ $ mvn -D org.slf4j.simpleLogger.defaultLogLevel=info clean compiler:compile gene
 
 ## Tests
 
-Beware, tests are currently still doing real HTTP requests to the GitHub API.
+Beware, tests that are not run with the `mock` feature are currently still doing real HTTP requests to the GitHub API.
 
 Run the wasm tests:
 
@@ -111,4 +150,21 @@ Run the sync tests:
 $ cargo test --features isahc,mercy,squirrel-girl,inertia,starfox --target x86_64-unknown-linux-gnu -- --nocapture
 ```
 
+In order to avoid GitHub's API rate limiting, you can run the non-wasm tests using wiremock.
+You'll need to start wiremock in the background:
+
+```nocompile
+$ docker run -d --name wiremock -p 8080:8080 -v $PWD/tests/stubs:/home/wiremock
+rodolpheche/wiremock
+```
+
+#### Regenerate the wiremock stubs
+
+You should regenerate the stubs if the remote API has changed:
+
+```nocompile
+$ docker run -d --name wiremock -p 8080:8080 -v $PWD/tests/stubs:/home/wiremock -u (id -u):(id -g) rodolpheche/wiremock --verbose --proxy-all="https://api.github.com" --record-mappings
+```
+
+
 License: Apache-2.0

README.md

@@ -9,6 +9,7 @@
 
 public class CodegenTag extends CodegenObject {
     public String baseName;
+	public String classname;
     public List<CodegenOperation> operations;
     public List<CodegenContent> contents = new ArrayList<>();
 	public String getBaseName() {
@@ -28,6 +29,8 @@ public int hashCode() {
 		final int prime = 31;
 		int result = 1;
 		result = prime * result + ((baseName == null) ? 0 : baseName.hashCode());
+		result = prime * result + ((classname == null) ? 0 : classname.hashCode());
+		result = prime * result + ((contents == null) ? 0 : contents.hashCode());
 		result = prime * result + ((operations == null) ? 0 : operations.hashCode());
 		return result;
 	}
@@ -45,6 +48,16 @@ public boolean equals(Object obj) {
 				return false;
 		} else if (!baseName.equals(other.baseName))
 			return false;
+		if (classname == null) {
+			if (other.classname != null)
+				return false;
+		} else if (!classname.equals(other.classname))
+			return false;
+		if (contents == null) {
+			if (other.contents != null)
+				return false;
+		} else if (!contents.equals(other.contents))
+			return false;
 		if (operations == null) {
 			if (other.operations != null)
 				return false;
@@ -58,4 +71,10 @@ public List<CodegenContent> getContents() {
 	public void setContents(List<CodegenContent> contents) {
 		this.contents = contents;
 	}
+	public String getClassname() {
+		return classname;
+	}
+	public void setClassname(String classname) {
+		this.classname = classname;
+	}
 }

java/github/CodegenTag.java

@@ -22,7 +22,7 @@
 import io.swagger.codegen.v3.CodegenParameter;
 import io.swagger.codegen.v3.CodegenProperty;
 import io.swagger.codegen.v3.CodegenResponse;
-import io.swagger.codegen.v3.generators.handlebars.java.JavaHelper;
+import io.swagger.codegen.v3.SupportingFile;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.info.Info;
@@ -39,7 +39,7 @@ public GitHubCodegen() {
         super();
 
         additionalProperties.put("tags", tagList.values());
-        // supportingFiles.add(new SupportingFile("api_impl.rs", "src", "api_impl.rs"));
+        supportingFiles.add(new SupportingFile("lib.mustache", "src", "lib.rs"));
     }
 
     private static HashMap<String, Object> patchOperationBodyNames = new HashMap();
@@ -186,6 +186,7 @@ public void addOperationToGroup(String tag, String resourcePath, Operation opera
         } else {
             codegenTag = new CodegenTag();
             codegenTag.baseName = underscore(tag);
+            codegenTag.classname = tag;
             codegenTag.operations = new ArrayList<CodegenOperation>();
             tagList.put(tag, codegenTag);
         }

java/github/GitHubCodegen.java

@@ -150,13 +150,8 @@ public RustServerCodegen() {
          * entire object tree available. If the input file has a suffix of `.mustache it
          * will be processed by the template engine. Otherwise, it will be copied
          */
-        //supportingFiles.clear();
-        // supportingFiles.add(new SupportingFile("lib.mustache", "src", "lib.rs"));
         supportingFiles.add(new SupportingFile("models.mustache", "src", "models.rs"));
         supportingFiles.add(new SupportingFile("endpoints.mustache", "src/endpoints", "mod.rs"));
-        //supportingFiles.add(new SupportingFile("api.mustache", "src", "api.rs"));
-        // supportingFiles.add(new SupportingFile("client.mustache", "src",
-        // "client.rs"));
 
     }
 

java/github/RustServerCodegen.java

@@ -25,7 +25,7 @@ pub(crate) fn fetch(request: Request<Body>) -> Result<Response<Body>, AdapterErr
 }
 
 pub(crate) async fn fetch_async(_request: Request<Body>) -> Result<Response<Body>, AdapterError> {
-    unimplemented!()
+    todo!()
 }
 
 impl<T: std::io::Read> GitHubResponseExt for Response<T> {