Rename files and vars to use camel case inline with the naming conven…

…tion (#1048) Co-authored-by: Ansible-lightspeed-Bot <ansible_lightspeed_bot@redhat.com>
ansible · Jan 17, 2024 · 33cb5de · 33cb5de
1 parent bcc4fae
commit 33cb5de
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 40 deletions.
diff --git a/src/features/lightspeed/api.ts b/src/features/lightspeed/api.ts
@@ -18,7 +18,7 @@ import {
 import { LightSpeedAuthenticationProvider } from "./lightSpeedOAuthProvider";
 import { getBaseUri } from "./utils/webUtils";
 import { ANSIBLE_LIGHTSPEED_API_TIMEOUT } from "../../definitions/constants";
-import { retrieve_error } from "./handle_api_error";
+import { retrieveError } from "./handleApiError";
 
 export class LightSpeedAPI {
   private axiosInstance: AxiosInstance | undefined;
@@ -113,7 +113,7 @@ export class LightSpeedAPI {
       return response.data;
     } catch (error) {
       const err = error as AxiosError;
-      vscode.window.showErrorMessage(retrieve_error(err));
+      vscode.window.showErrorMessage(retrieveError(err));
       this._completionRequestInProgress = false;
       return {} as CompletionResponseParams;
     } finally {

diff --git a/src/features/lightspeed/handle_api_error.ts → src/features/lightspeed/handleApiError.ts b/src/features/lightspeed/handle_api_error.ts → src/features/lightspeed/handleApiError.ts
@@ -1,6 +1,6 @@
 import { AxiosError } from "axios";
 
-export function retrieve_error(err: AxiosError): string {
+export function retrieveError(err: AxiosError): string {
   if (err && "response" in err) {
     if (err?.response?.status === 401) {
       return "User not authorized to access Ansible Lightspeed.";

diff --git a/test/units/lightspeed/contentmatches.test.ts b/test/units/lightspeed/contentmatches.test.ts
@@ -22,8 +22,8 @@ import {
   ISuggestionDetails,
 } from "../../../src/interfaces/lightspeed";
 
-function create_match_response(): ContentMatchesResponseParams {
-  const content_match_params = {
+function createMatchResponse(): ContentMatchesResponseParams {
+  const contentMatchParams = {
     repo_name: "ansible.ansible",
     repo_url: "https://github.com/ansible/ansible",
     path: "some/file.py",
@@ -32,13 +32,13 @@ function create_match_response(): ContentMatchesResponseParams {
     score: 123,
   } as IContentMatchParams;
   const icontent_match = {
-    contentmatch: [content_match_params],
+    contentmatch: [contentMatchParams],
   } as IContentMatch;
 
   return { contentmatches: [icontent_match] } as ContentMatchesResponseParams;
 }
 
-function create_content_matches_webview(): ContentMatchesWebview {
+function createContentMatchesWebview(): ContentMatchesWebview {
   const m_context: Partial<ExtensionContext> = {};
   const m_client: Partial<LanguageClient> = {};
   const m_settings: Partial<SettingsManager> = {};
@@ -58,12 +58,12 @@ function create_content_matches_webview(): ContentMatchesWebview {
 
 describe("ContentMatches view", () => {
   it("with normal input", async function () {
-    const cmw = create_content_matches_webview();
+    const cmw = createContentMatchesWebview();
     cmw.apiInstance.contentMatchesRequest = async (
       inputData: ContentMatchesRequestParams
     ): Promise<ContentMatchesResponseParams> => {
       assert.equal(inputData.model, undefined);
-      return create_match_response();
+      return createMatchResponse();
     };
     const res = await cmw.requestInlineSuggestContentMatches("foo", "bar");
     assert.equal(
@@ -73,13 +73,13 @@ describe("ContentMatches view", () => {
   });
 
   it("with a specific model", async function () {
-    const cmw = create_content_matches_webview();
+    const cmw = createContentMatchesWebview();
     cmw.settingsManager.settings.lightSpeedService.model = "the_model";
     cmw.apiInstance.contentMatchesRequest = async (
       inputData: ContentMatchesRequestParams
     ): Promise<ContentMatchesResponseParams> => {
       assert.equal(inputData.model, "the_model");
-      return create_match_response();
+      return createMatchResponse();
     };
     const res = await cmw.requestInlineSuggestContentMatches("foo", "bar");
     assert.equal(
@@ -91,13 +91,13 @@ describe("ContentMatches view", () => {
 
 describe("GetWebviewContent", () => {
   it("no suggestion", async function () {
-    const cmw = create_content_matches_webview();
+    const cmw = createContentMatchesWebview();
     const res = await cmw["getWebviewContent"]();
     assert.match(res, new RegExp("No training matches found"));
   });
 
   it("suggestion has no matches", async function () {
-    const cmw = create_content_matches_webview();
+    const cmw = createContentMatchesWebview();
     cmw.suggestionDetails = [
       {
         suggestion: "- name: foo\n  my.mod:\n",
@@ -107,7 +107,7 @@ describe("GetWebviewContent", () => {
     cmw.apiInstance.contentMatchesRequest = async (
       inputData: ContentMatchesRequestParams // eslint-disable-line @typescript-eslint/no-unused-vars
     ): Promise<ContentMatchesResponseParams> => {
-      const res = create_match_response();
+      const res = createMatchResponse();
       res.contentmatches = [];
       return res;
     };
@@ -116,7 +116,7 @@ describe("GetWebviewContent", () => {
   });
 
   it("suggest has invalid YAML", async function () {
-    const cmw = create_content_matches_webview();
+    const cmw = createContentMatchesWebview();
     cmw.suggestionDetails = [
       {
         suggestion: "- name: foo\nI\n\nBROKEN\n",
@@ -126,7 +126,7 @@ describe("GetWebviewContent", () => {
     cmw.apiInstance.contentMatchesRequest = async (
       inputData: ContentMatchesRequestParams // eslint-disable-line @typescript-eslint/no-unused-vars
     ): Promise<ContentMatchesResponseParams> => {
-      return create_match_response();
+      return createMatchResponse();
     };
     const spiedConsole = sinon.spy(console, "log");
     const res = await cmw["getWebviewContent"]();
@@ -141,7 +141,7 @@ describe("GetWebviewContent", () => {
   });
 
   it("suggestion with a match", async function () {
-    const cmw = create_content_matches_webview();
+    const cmw = createContentMatchesWebview();
     cmw.suggestionDetails = [
       {
         suggestion: "- name: foo\n  my.mod:\n",
@@ -151,7 +151,7 @@ describe("GetWebviewContent", () => {
     cmw.apiInstance.contentMatchesRequest = async (
       inputData: ContentMatchesRequestParams // eslint-disable-line @typescript-eslint/no-unused-vars
     ): Promise<ContentMatchesResponseParams> => {
-      return create_match_response();
+      return createMatchResponse();
     };
 
     function setRhUserHasSeat(has_seat: boolean) {

diff --git a/...units/lightspeed/handle_api_error.test.ts → test/units/lightspeed/handleApiError.test.ts b/...units/lightspeed/handle_api_error.test.ts → test/units/lightspeed/handleApiError.test.ts
@@ -1,10 +1,10 @@
 require("assert");
 
 import { AxiosError, AxiosHeaders } from "axios";
-import { retrieve_error } from "../../../src/features/lightspeed/handle_api_error";
+import { retrieveError } from "../../../src/features/lightspeed/handleApiError";
 import assert from "assert";
 
-function create_error(http_code: number, data = {}): AxiosError {
+function createError(http_code: number, data = {}): AxiosError {
   const request = { path: "/wisdom" };
   const headers = new AxiosHeaders({
     "Access-Control-Allow-Origin": "*",
@@ -33,48 +33,48 @@ function create_error(http_code: number, data = {}): AxiosError {
 
 describe("testing the error handling", () => {
   it("err generic", () => {
-    const msg = retrieve_error(create_error(200));
+    const msg = retrieveError(createError(200));
     assert.equal(
       msg,
       "Failed to fetch inline suggestion from Ansible Lightspeed with status code: 200. Try again after some time."
     );
   });
   it("err Unauthorized", () => {
-    const msg = retrieve_error(create_error(401));
+    const msg = retrieveError(createError(401));
     assert.equal(msg, "User not authorized to access Ansible Lightspeed.");
   });
   it("err Too Many Requests", () => {
-    const msg = retrieve_error(create_error(429));
+    const msg = retrieveError(createError(429));
     assert.equal(
       msg,
       "Too many requests to Ansible Lightspeed. Please try again after some time."
     );
   });
   it("err Bad Request from Cloudflare", () => {
-    const msg = retrieve_error(
-      create_error(400, { message: "Some string from Cloudflare." })
+    const msg = retrieveError(
+      createError(400, { message: "Some string from Cloudflare." })
     );
     assert.equal(
       msg,
       "Cloudflare rejected the request. Please contact your administrator."
     );
   });
   it("err Bad Request", () => {
-    const msg = retrieve_error(create_error(400));
+    const msg = retrieveError(createError(400));
     assert.equal(msg, "Bad Request response. Please try again.");
   });
   it("err Forbidden - WCA Model ID is invalid", () => {
-    const msg = retrieve_error(
-      create_error(403, { message: "WCA Model ID is invalid" })
+    const msg = retrieveError(
+      createError(403, { message: "WCA Model ID is invalid" })
     );
     assert.equal(
       msg,
       `Model ID is invalid. Please contact your administrator.`
     );
   });
   it("err Forbidden - No seat", () => {
-    const msg = retrieve_error(
-      create_error(403, {
+    const msg = retrieveError(
+      createError(403, {
         code: "permission_denied__org_ready_user_has_no_seat",
       })
     );
@@ -84,8 +84,8 @@ describe("testing the error handling", () => {
     );
   });
   it("err Forbidden - Trial expired", () => {
-    const msg = retrieve_error(
-      create_error(403, {
+    const msg = retrieveError(
+      createError(403, {
         code: "permission_denied__user_trial_expired",
       })
     );
@@ -95,8 +95,8 @@ describe("testing the error handling", () => {
     );
   });
   it("err Forbidden - WCA not ready", () => {
-    const msg = retrieve_error(
-      create_error(403, {
+    const msg = retrieveError(
+      createError(403, {
         code: "permission_denied__org_not_ready_because_wca_not_configured",
       })
     );
@@ -106,35 +106,35 @@ describe("testing the error handling", () => {
     );
   });
   it("err Forbidden", () => {
-    const msg = retrieve_error(create_error(403));
+    const msg = retrieveError(createError(403));
     assert.equal(msg, `User not authorized to access Ansible Lightspeed.`);
   });
   it("err Internal Server Error", () => {
-    const msg = retrieve_error(create_error(500));
+    const msg = retrieveError(createError(500));
     assert.equal(
       msg,
       `Ansible Lightspeed encountered an error. Try again after some time.`
     );
   });
   it("err Unexpected Err code", () => {
-    const msg = retrieve_error(create_error(999));
+    const msg = retrieveError(createError(999));
     assert.equal(
       msg,
       "Failed to fetch inline suggestion from Ansible Lightspeed with status code: 999. Try again after some time."
     );
   });
   it("err Timeout", () => {
-    const err = create_error(0);
+    const err = createError(0);
     err.code = AxiosError.ECONNABORTED;
-    const msg = retrieve_error(err);
+    const msg = retrieveError(err);
     assert.equal(
       msg,
       "Ansible Lightspeed connection timeout. Try again after some time."
     );
   });
 
   it("err Unexpected Client error", () => {
-    const msg = retrieve_error(create_error(0));
+    const msg = retrieveError(createError(0));
     assert.equal(
       msg,
       "Failed to fetch inline suggestion from Ansible Lightspeed. Try again after some time."