Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: organize core pepr files into lib/core/ #1594

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/cli/build.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import { expect, describe, it, jest, beforeEach } from "@jest/globals";
import { createDockerfile } from "../lib/included-files";
import { execSync } from "child_process";
import { CapabilityExport } from "../lib/types";
import { Capability } from "../lib/capability";
import { Capability } from "../lib/core/capability";

jest.mock("child_process", () => ({
execSync: jest.fn(),
Expand Down
4 changes: 2 additions & 2 deletions src/lib.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { K8s, RegisterKind, kind as a, fetch, fetchStatus, kind } from "kubernetes-fluent-client";
import * as R from "ramda";

import { Capability } from "./lib/capability";
import { Capability } from "./lib/core/capability";
import Log from "./lib/telemetry/logger";
import { PeprModule } from "./lib/module";
import { PeprModule } from "./lib/core/module";
import { PeprMutateRequest } from "./lib/mutate-request";
import * as PeprUtils from "./lib/utils";
import { PeprValidateRequest } from "./lib/validate-request";
Expand Down
2 changes: 1 addition & 1 deletion src/lib/assets/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import crypto from "crypto";
import { dumpYaml } from "@kubernetes/client-node";
import { kind } from "kubernetes-fluent-client";
import { ModuleConfig } from "../module";
import { ModuleConfig } from "../core/module";
import { TLSOut, genTLS } from "../tls";
import { CapabilityExport } from "../types";
import { WebhookIgnore } from "../k8s";
Expand Down
2 changes: 1 addition & 1 deletion src/lib/assets/pods.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { getNamespace, getWatcher, getDeployment, getModuleSecret, genEnv } from "./pods";
import { expect, describe, test, jest, afterEach } from "@jest/globals";
import { Assets } from ".";
import { ModuleConfig } from "../module";
import { ModuleConfig } from "../core/module";
import { gzipSync } from "zlib";

jest.mock("zlib");
Expand Down
2 changes: 1 addition & 1 deletion src/lib/assets/pods.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { kind } from "kubernetes-fluent-client";
import { gzipSync } from "zlib";
import { secretOverLimit } from "../helpers";
import { Assets } from ".";
import { ModuleConfig } from "../module";
import { ModuleConfig } from "../core/module";
import { Binding } from "../types";

/** Generate the pepr-system namespace */
Expand Down
4 changes: 2 additions & 2 deletions src/lib/controller/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
import fs from "fs";
import https from "https";

import { Capability } from "../capability";
import { Capability } from "../core/capability";
import { MutateResponse, ValidateResponse } from "../k8s";
import Log from "../telemetry/logger";
import { metricsCollector, MetricsCollector } from "../telemetry/metrics";
import { ModuleConfig, isWatchMode } from "../module";
import { ModuleConfig, isWatchMode } from "../core/module";
import { mutateProcessor } from "../processors/mutate-processor";
import { validateProcessor } from "../processors/validate-processor";
import { StoreController } from "./store";
Expand Down Expand Up @@ -39,7 +39,7 @@
readonly #beforeHook?: (req: AdmissionRequest) => void;
readonly #afterHook?: (res: MutateResponse | ValidateResponse) => void;

constructor(

Check warning on line 42 in src/lib/controller/index.ts

View workflow job for this annotation

GitHub Actions / format

Constructor has too many parameters (5). Maximum allowed is 4
config: ModuleConfig,
capabilities: Capability[],
beforeHook?: (req: AdmissionRequest) => void,
Expand Down
4 changes: 2 additions & 2 deletions src/lib/controller/store.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

import { StoreController } from "./store";
import { CapabilityCfg } from "../types";
import { Capability } from "../capability";
import { Schedule } from "../schedule";
import { Capability } from "../core/capability";
import { Schedule } from "../core/schedule";
import { Store } from "../k8s";
import { afterEach, describe, it, jest, beforeEach, expect } from "@jest/globals";
import { GenericClass, K8s, KubernetesObject } from "kubernetes-fluent-client";
Expand Down
4 changes: 2 additions & 2 deletions src/lib/controller/store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import { Operation } from "fast-json-patch";
import { K8s } from "kubernetes-fluent-client";
import { startsWith } from "ramda";

import { Capability } from "../capability";
import { Capability } from "../core/capability";
import { Store } from "../k8s";
import Log, { redactedPatch, redactedStore } from "../telemetry/logger";
import { DataOp, DataSender, DataStore, Storage } from "../storage";
import { DataOp, DataSender, DataStore, Storage } from "../core/storage";
import { fillStoreCache, sendUpdatesAndFlushCache } from "./storeCache";

const namespace = "pepr-system";
Expand Down
2 changes: 1 addition & 1 deletion src/lib/controller/storeCache.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { DataOp } from "../storage";
import { DataOp } from "../core/storage";
import Log from "../telemetry/logger";
import { K8s } from "kubernetes-fluent-client";
import { Store } from "../k8s";
Expand Down
16 changes: 8 additions & 8 deletions src/lib/capability.test.ts → src/lib/core/capability.test.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { Capability } from "./capability";
import Log from "./telemetry/logger";
import { CapabilityCfg, FinalizeAction, MutateAction, ValidateAction, WatchLogAction } from "./types";
import { a } from "../lib";
import Log from "../telemetry/logger";
import { CapabilityCfg, FinalizeAction, MutateAction, ValidateAction, WatchLogAction } from "../types";
import { a } from "../../lib";
import { V1Pod } from "@kubernetes/client-node";
import { expect, describe, jest, beforeEach, it } from "@jest/globals";
import { Event, Operation } from "./enums";
import { PeprMutateRequest } from "./mutate-request";
import { PeprValidateRequest } from "./validate-request";
import { AdmissionRequest } from "./types";
import { Event, Operation } from "../enums";
import { PeprMutateRequest } from "../mutate-request";
import { PeprValidateRequest } from "../validate-request";
import { AdmissionRequest } from "../types";
import { WatchPhase } from "kubernetes-fluent-client/dist/fluent/types";
import { GenericClass } from "kubernetes-fluent-client";
import { Schedule } from "./schedule";
Expand All @@ -21,7 +21,7 @@
}));

// Mock logger globally
jest.mock("./telemetry/logger", () => ({
jest.mock("../telemetry/logger", () => ({
__esModule: true,
default: {
info: jest.fn(),
Expand All @@ -46,7 +46,7 @@

const mockLog = Log as jest.Mocked<typeof Log>;

describe("Capability", () => {

Check warning on line 49 in src/lib/core/capability.test.ts

View workflow job for this annotation

GitHub Actions / format

Arrow function has too many statements (29). Maximum allowed is 20
let mockRequest: AdmissionRequest<V1Pod>;

beforeEach(() => {
Expand Down
8 changes: 4 additions & 4 deletions src/lib/capability.ts → src/lib/core/capability.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

import { GenericClass, GroupVersionKind, modelToGroupVersionKind } from "kubernetes-fluent-client";
import { pickBy } from "ramda";
import Log from "./telemetry/logger";
import Log from "../telemetry/logger";
import { isBuildMode, isDevMode, isWatchMode } from "./module";
import { PeprStore, Storage } from "./storage";
import { OnSchedule, Schedule } from "./schedule";
import { Event } from "./enums";
import { Event } from "../enums";
import {
Binding,
BindingFilter,
Expand All @@ -22,8 +22,8 @@
FinalizeAction,
FinalizeActionChain,
WhenSelector,
} from "./types";
import { addFinalizer } from "./finalizer";
} from "../types";
import { addFinalizer } from "../finalizer";

const registerAdmission = isBuildMode() || !isWatchMode();
const registerWatch = isBuildMode() || isWatchMode() || isDevMode();
Expand Down Expand Up @@ -180,7 +180,7 @@
* @param kind if using a custom KubernetesObject not available in `a.*`, specify the GroupVersionKind
* @returns
*/
When = <T extends GenericClass>(model: T, kind?: GroupVersionKind): WhenSelector<T> => {

Check warning on line 183 in src/lib/core/capability.ts

View workflow job for this annotation

GitHub Actions / format

Method 'When' has too many statements (26). Maximum allowed is 20
const matchedKind = modelToGroupVersionKind(model.name);

// If the kind is not specified and the model is not a KubernetesObject, throw an error
Expand Down
6 changes: 3 additions & 3 deletions src/lib/module.test.ts → src/lib/core/module.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import { beforeEach, expect, jest, test, describe } from "@jest/globals";
import { clone } from "ramda";
import { Capability } from "./capability";
import { Schedule } from "./schedule";
import { Errors } from "./errors";
import { Errors } from "../errors";
import { PackageJSON, PeprModule } from "./module";
import { CapabilityExport } from "./types";
import { CapabilityExport } from "../types";

// Mock Controller
const startServerMock = jest.fn();
jest.mock("./controller", () => {
jest.mock("../controller", () => {
return {
Controller: jest.fn().mockImplementation(() => {
return { startServer: startServerMock };
Expand Down
12 changes: 6 additions & 6 deletions src/lib/module.ts → src/lib/core/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
import { clone } from "ramda";
import { Capability } from "./capability";
import { Controller } from "./controller";
import { ValidateError } from "./errors";
import { MutateResponse, ValidateResponse, WebhookIgnore } from "./k8s";
import { CapabilityExport, AdmissionRequest } from "./types";
import { setupWatch } from "./processors/watch-processor";
import { Log } from "../lib";
import { Controller } from "../controller";
import { ValidateError } from "../errors";
import { MutateResponse, ValidateResponse, WebhookIgnore } from "../k8s";
import { CapabilityExport, AdmissionRequest } from "../types";
import { setupWatch } from "../processors/watch-processor";
import { Log } from "../../lib";
import { V1PolicyRule as PolicyRule } from "@kubernetes/client-node";

/** Custom Labels Type for package.json */
Expand Down
4 changes: 2 additions & 2 deletions src/lib/queue.test.ts → src/lib/core/queue.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { afterEach, describe, expect, jest, it } from "@jest/globals";
import { WatchPhase } from "kubernetes-fluent-client/dist/fluent/types";
import { Queue } from "./queue";

import Log from "./telemetry/logger";
jest.mock("./telemetry/logger");
import Log from "../telemetry/logger";
jest.mock("../telemetry/logger");

describe("Queue", () => {
afterEach(() => {
Expand Down
2 changes: 1 addition & 1 deletion src/lib/queue.ts → src/lib/core/queue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import { KubernetesObject } from "@kubernetes/client-node";
import { WatchPhase } from "kubernetes-fluent-client/dist/fluent/types";
import { randomBytes } from "node:crypto";
import Log from "./telemetry/logger";
import Log from "../telemetry/logger";

type WatchCallback = (obj: KubernetesObject, phase: WatchPhase) => Promise<void>;

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/lib/processors/mutate-processor.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import { beforeEach, describe, expect, it, jest } from "@jest/globals";
import { clone } from "ramda";
import { ModuleConfig } from "../module";
import { ModuleConfig } from "../core/module";
import { PeprMutateRequest } from "../mutate-request";
import * as sut from "./mutate-processor";
import { AdmissionRequest, Binding, MutateAction } from "../types";
Expand Down
4 changes: 2 additions & 2 deletions src/lib/processors/mutate-processor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import jsonPatch from "fast-json-patch";
import { kind, KubernetesObject } from "kubernetes-fluent-client";
import { clone } from "ramda";

import { Capability } from "../capability";
import { Capability } from "../core/capability";
import { Errors } from "../errors";
import { shouldSkipRequest } from "../filter/filter";
import { MutateResponse } from "../k8s";
import { AdmissionRequest, Binding } from "../types";
import Log from "../telemetry/logger";
import { ModuleConfig } from "../module";
import { ModuleConfig } from "../core/module";
import { PeprMutateRequest } from "../mutate-request";
import { base64Encode, convertFromBase64Map, convertToBase64Map } from "../utils";

Expand Down
4 changes: 2 additions & 2 deletions src/lib/processors/validate-processor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
// SPDX-FileCopyrightText: 2023-Present The Pepr Authors

import { kind, KubernetesObject } from "kubernetes-fluent-client";
import { Capability } from "../capability";
import { Capability } from "../core/capability";
import { shouldSkipRequest } from "../filter/filter";
import { ValidateResponse } from "../k8s";
import { AdmissionRequest, Binding } from "../types";
import Log from "../telemetry/logger";
import { convertFromBase64Map } from "../utils";
import { PeprValidateRequest } from "../validate-request";
import { ModuleConfig } from "../module";
import { ModuleConfig } from "../core/module";

export async function processRequest(
binding: Binding,
Expand Down
2 changes: 1 addition & 1 deletion src/lib/processors/watch-processor.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { GenericClass, K8s, KubernetesObject, kind } from "kubernetes-fluent-client";
import { K8sInit, WatchPhase } from "kubernetes-fluent-client/dist/fluent/types";
import { WatchCfg, WatchEvent, Watcher } from "kubernetes-fluent-client/dist/fluent/watch";
import { Capability } from "../capability";
import { Capability } from "../core/capability";
import { setupWatch, logEvent, queueKey, getOrCreateQueue } from "./watch-processor";
import Log from "../telemetry/logger";
import { metricsCollector } from "../telemetry/metrics";
Expand Down Expand Up @@ -154,7 +154,7 @@
setupWatch(capabilities);
});

it("should setup watches with correct phases for different events", async () => {

Check warning on line 157 in src/lib/processors/watch-processor.test.ts

View workflow job for this annotation

GitHub Actions / format

Async arrow function has too many statements (39). Maximum allowed is 20
const watchCallbackCreate = jest.fn();
const watchCallbackUpdate = jest.fn();
const watchCallbackDelete = jest.fn();
Expand Down
4 changes: 2 additions & 2 deletions src/lib/processors/watch-processor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
import Log from "../telemetry/logger";
import { Binding } from "../types";
import { Capability } from "../capability";
import { Capability } from "../core/capability";
import { Event } from "../enums";
import { K8s, KubernetesObject, WatchCfg, WatchEvent } from "kubernetes-fluent-client";
import { Queue } from "../queue";
import { Queue } from "../core/queue";
import { WatchPhase } from "kubernetes-fluent-client/dist/fluent/types";
import { filterNoMatchReason } from "../filter/filter";
import { metricsCollector } from "../telemetry/metrics";
Expand Down
Loading