Merge pull request #1 from truefoundry/np-add-initial-policy

Initial policy template to run and execute

Author: pranjaltrvd

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+lib

.prettierignore

@@ -0,0 +1 @@
+src/models.ts

README.md

@@ -1 +1,29 @@
-# tfy-typescript-policy
+# TypeScript Policy
+
+This example is meant to be a boilerplate for your own typescript policy for validation or mutation on truefoundry.
+
+All the required models can be imported from {./src/models.ts}
+
+# How to build
+
+After extracting the example, make sure that the dependencies are installed with:
+```
+npm install
+```
+
+Now compile the policy and generate the kubernetes manifests:
+```
+npm run compile
+
+> ts-example-policy@0.1.0 compile
+> tsc && webpack --config webpack.config.js
+asset bundle.js 857 bytes [compared for emit] [minimized] (name: main)
+./lib/index.js 223 bytes [built] [code generated]
+./lib/policy.js 726 bytes [built] [code generated]
+webpack 5.36.1 compiled successfully in 229 ms
+```
+
+# Run the policy locally
+```Local Run
+npx ts-node local_run.ts
+```

jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+    transform: {
+        "^.+\\.tsx?$": "ts-jest",
+    },
+    testRegex: "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+    testPathIgnorePatterns: ["/lib/", "/node_modules/"],
+    moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+    collectCoverage: true,
+};

local_run.ts

@@ -0,0 +1,58 @@
+import { Service, Workspace } from './src/models';
+import { validate } from './src/policy';
+import { ValidationContext } from './src/types';
+
+const dummyWorkspace: Workspace = {
+    type: 'workspace',
+    cluster_fqn: 'test-cluster',
+    name: 'test-workspace'
+}
+
+const dummyValidationContext: ValidationContext = {
+    entity: 'service',
+    action: 'apply',
+    filters: {
+        env_name: 'dev',
+    }
+}
+
+// Sample service with GitHub build source (should throw error)
+const githubService: Service = {
+    type: 'service',
+    name: 'test-service',
+    image: {
+        type: 'build',
+        build_spec: {
+            type: 'dockerfile',
+            dockerfile_path: 'Dockerfile',
+            build_context_path: '.'
+        },
+        build_source: {
+            type: 'git',
+            repo_url: 'https://github.com/user/repo',
+            ref: 'main',
+        }
+    },
+    ports: [
+        {
+            port: 8080,
+            protocol: 'TCP',
+            expose: true
+        }
+    ],
+    auto_shutdown: {
+        wait_time: 300
+    }
+};
+
+const validationInput = {
+    manifest: githubService,
+    context: dummyValidationContext
+}
+
+try {
+    const validatedService = validate(validationInput); // will throw error that auto_shutdown wait_time should be less than 300 seconds for the dev environment
+    console.log(validatedService);
+} catch (error) {
+    console.error(error);
+}