Parse tome paramdefs on startup (#298)

* Set paramdefs on parse. * Removes debug statements. * Should fix tests * Missed this one * Updated UI. * Yay this works. * Remove debug statements. * Remove debug. * Rebuild UI. * auto reformat paramdefs to a JSON string. * Increase param def string size. * Updated UI * Add a non param example. * Add default value to params * Remove test. * Rebuild ui. * Remove test tome. * Add test 3 * Remove example 3 * Try updating parameters too. * Manually generated * Switch back to entry name metadata name is complex * Increase quest output drawer size (#306) * Set paramdefs on parse. * Removes debug statements. * Should fix tests * Missed this one * Updated UI. * Yay this works. * Remove debug statements. * Remove debug. * Rebuild UI. * auto reformat paramdefs to a JSON string. * Increase param def string size. * Updated UI * Add a non param example. * Add default value to params * Remove test. * Rebuild ui. * Remove test tome. * Add test 3 * Remove example 3 * Try updating parameters too. * Manually generated * Switch back to entry name metadata name is complex * Update UI.
spellshift · Oct 5, 2023 · d29a4a0 · d29a4a0
1 parent c70933e
commit d29a4a0
Show file tree

Hide file tree

Showing 20 changed files with 86 additions and 30 deletions.
diff --git a/implants/imix/src/main.rs b/implants/imix/src/main.rs
@@ -274,6 +274,7 @@ async fn main_loop(config_path: String, run_once: bool) -> Result<()> {
         if debug { println!("[{}]: Starting {} new tasks", (Utc::now().time() - start_time).num_milliseconds(), new_tasks.len()); }
         // 2. Start new tasks
         for task in new_tasks {
+            if debug { println!("Parameters:\n{:?}", task.clone().quest.parameters); }
             if debug { println!("Launching:\n{:?}", task.clone().quest.tome.eldritch); }
 
             let (sender, receiver) = channel::<String>();

diff --git a/implants/lib/eldritch/src/lib.rs b/implants/lib/eldritch/src/lib.rs
@@ -159,7 +159,6 @@ pub fn eldritch_run(tome_filename: String, tome_contents: String, tome_parameter
         };
         input_params.insert_hashed(hashed_key, new_value);
     }
-
     module.set("input_params", input_params.alloc_value(module.heap()));
 
     let mut eval: Evaluator = Evaluator::new(&module);

diff --git a/tavern/internal/ent/migrate/schema.go b/tavern/internal/ent/migrate/schema.go
diff --git a/tavern/internal/ent/schema/quest.go b/tavern/internal/ent/schema/quest.go
@@ -3,6 +3,7 @@ package schema
 import (
 	"entgo.io/contrib/entgql"
 	"entgo.io/ent"
+	"entgo.io/ent/dialect"
 	"entgo.io/ent/schema"
 	"entgo.io/ent/schema/edge"
 	"entgo.io/ent/schema/field"
@@ -23,6 +24,9 @@ func (Quest) Fields() []ent.Field {
 			).
 			Comment("Name of the quest"),
 		field.String("parameters").
+			SchemaType(map[string]string{
+				dialect.MySQL: "LONGTEXT", // Override MySQL, improve length maximum
+			}).
 			Optional().
 			Comment("Value of parameters that were specified for the quest (as a JSON string)."),
 	}

diff --git a/tavern/internal/ent/schema/tome.go b/tavern/internal/ent/schema/tome.go
@@ -33,6 +33,9 @@ func (Tome) Fields() []ent.Field {
 			Comment("Information about the tome"),
 		field.String("param_defs").
 			Optional().
+			SchemaType(map[string]string{
+				dialect.MySQL: "LONGTEXT", // Override MySQL, improve length maximum
+			}).
 			Comment("JSON string describing what parameters are used with the tome"),
 		field.String("hash").
 			MaxLen(100).

diff --git a/tavern/internal/www/build/asset-manifest.json b/tavern/internal/www/build/asset-manifest.json
@@ -1,16 +1,16 @@
 {
   "files": {
     "main.css": "/static/css/main.d3a1f05a.css",
-    "main.js": "/static/js/main.d00b684e.js",
+    "main.js": "/static/js/main.dce5904d.js",
     "static/js/787.4af0fb89.chunk.js": "/static/js/787.4af0fb89.chunk.js",
     "static/media/eldrich.png": "/static/media/eldrich.a80c74e8249d2461e174.png",
     "index.html": "/index.html",
     "main.d3a1f05a.css.map": "/static/css/main.d3a1f05a.css.map",
-    "main.d00b684e.js.map": "/static/js/main.d00b684e.js.map",
+    "main.dce5904d.js.map": "/static/js/main.dce5904d.js.map",
     "787.4af0fb89.chunk.js.map": "/static/js/787.4af0fb89.chunk.js.map"
   },
   "entrypoints": [
     "static/css/main.d3a1f05a.css",
-    "static/js/main.d00b684e.js"
+    "static/js/main.dce5904d.js"
   ]
 }
diff --git a/tavern/internal/www/build/index.html b/tavern/internal/www/build/index.html
@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>React App</title><script defer="defer" src="/static/js/main.d00b684e.js"></script><link href="/static/css/main.d3a1f05a.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>React App</title><script defer="defer" src="/static/js/main.dce5904d.js"></script><link href="/static/css/main.d3a1f05a.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
diff --git a/tavern/internal/www/build/static/js/main.d00b684e.js.map b/tavern/internal/www/build/static/js/main.d00b684e.js.map
diff --git a/...rnal/www/build/static/js/main.d00b684e.js → ...rnal/www/build/static/js/main.dce5904d.js b/...rnal/www/build/static/js/main.d00b684e.js → ...rnal/www/build/static/js/main.dce5904d.js
diff --git a/...ld/static/js/main.d00b684e.js.LICENSE.txt → ...ld/static/js/main.dce5904d.js.LICENSE.txt b/...ld/static/js/main.d00b684e.js.LICENSE.txt → ...ld/static/js/main.dce5904d.js.LICENSE.txt
diff --git a/tavern/internal/www/build/static/js/main.dce5904d.js.map b/tavern/internal/www/build/static/js/main.dce5904d.js.map
diff --git a/tavern/internal/www/src/hooks/useSubmitQuest.ts b/tavern/internal/www/src/hooks/useSubmitQuest.ts
@@ -47,12 +47,23 @@ export const useSubmitQuest = () => {
       ]});
 
     const submitQuest = (props: CreateQuestProps) => {
+        var param_obj = {}
+        for (var param of props.params) {
+            var tmp_param = {
+                [param.name]: param.value
+            }
+            param_obj = {
+                ...tmp_param,
+                ...param_obj,
+            }
+        }
         const formatVariables = {
             "variables": {
                 "IDs": props.beacons,
                 "input": {
                     "name": props?.name,
-                    "tomeID": props.tome?.id
+                    "tomeID": props.tome?.id,
+                    "parameters": JSON.stringify(param_obj),
                 }
             }
         };

diff --git a/tavern/internal/www/src/pages/create-quest/select-tome/SelectTome.tsx b/tavern/internal/www/src/pages/create-quest/select-tome/SelectTome.tsx
@@ -26,12 +26,12 @@ const GET_TOMES = gql`
 export const SelectTome = (props: Props) => {
     const { loading, error, data } = useQuery(GET_TOMES);
     const step = 0;
-    const {setCurrStep, formik} = props;
+    const { setCurrStep, formik } = props;
 
     const handleSelectTome = (tome: Tome) => {
         const { params } = safelyJsonParse(tome?.paramDefs);
         formik.setFieldValue('tome', tome);
-        formik.setFieldValue('params', params);
+        formik.setFieldValue('params', params ? params : []);
     }
 
     const handleNameQuest = (name: string) => {
@@ -44,7 +44,7 @@ export const SelectTome = (props: Props) => {
     // PARAMS SUBMITTED FOR CREATE QUEST FORMAT:  JSON STRING Dict<string, string>: '{"blah": "some value"}'
     //      * This is what is submitted for creating a quest
 
-    const hasAllParamsSet = formik?.values?.params.filter( (param: TomeParams) => {
+    const hasAllParamsSet = formik?.values?.params.filter((param: TomeParams) => {
         return param?.value && param?.value !== "";
     });
 
@@ -59,16 +59,16 @@ export const SelectTome = (props: Props) => {
                 label="Quest name"
                 placeholder={"Provide a recognizable name to this quest"}
                 value={formik?.values?.name}
-                onChange={(event)=> handleNameQuest(event?.target?.value)}
+                onChange={(event) => handleNameQuest(event?.target?.value)}
             />
 
-             <FormRadioGroup
+            <FormRadioGroup
                 label="Select a tome"
                 data={data?.tomes || []}
                 selected={formik?.values?.tome}
                 setSelected={handleSelectTome}
             />
-             {formik?.values?.params.length > 0 && formik?.values?.params.map((field: TomeParams, index: number) => {
+            {formik?.values?.params.length > 0 && formik?.values?.params.map((field: TomeParams, index: number) => {
                 return (
                     <FormTextArea
                         key={field.name}
@@ -77,17 +77,17 @@ export const SelectTome = (props: Props) => {
                         formik={formik}
                     />
                 );
-             })}
+            })}
 
-             <div className="flex flex-row gap-2">
+            <div className="flex flex-row gap-2">
                 <button
                     className="btn-primary"
-                    onClick={() => setCurrStep(step +1)}
+                    onClick={() => setCurrStep(step + 1)}
                     disabled={isContinueDisabled}
                 >
                     Continue
                 </button>
-             </div>
+            </div>
         </div>
     )
-}
+}
diff --git a/tavern/internal/www/src/utils/consts.ts b/tavern/internal/www/src/utils/consts.ts
@@ -38,10 +38,17 @@ export type TagContextType = {
     groupTags: Array<TomeTag>,
     serviceTags: Array<TomeTag>
 }
+export type QuestParam = {
+    label: string,
+    name: string,
+    placeholder: string,
+    type: string,
+    value: string,
+}
 export type CreateQuestProps = {
     name: string,
     tome: Tome | null,
-    params: any,
+    params: Array<QuestParam>,
     beacons: Array<string>,
 };
 

diff --git a/tavern/tomes/example/linux/test-file b/tavern/tomes/example/linux/test-file
@@ -0,0 +1 @@
+This file exists 
diff --git a/tavern/tomes/example/linux/test-implant b/tavern/tomes/example/linux/test-implant
diff --git a/tavern/tomes/example/main.eldritch b/tavern/tomes/example/main.eldritch
@@ -1 +1 @@
-print("Hello World")
+print(input_params['msg'])
diff --git a/tavern/tomes/example/metadata.yml b/tavern/tomes/example/metadata.yml
@@ -1,2 +1,7 @@
 name: example
-description: An example tome!
+description: An example tome!
+paramdefs:
+- name: msg
+  label: Message
+  type: string
+  placeholder: Something to print
diff --git a/tavern/tomes/parse.go b/tavern/tomes/parse.go
@@ -2,6 +2,7 @@ package tomes
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"io/fs"
 	"path/filepath"
@@ -12,7 +13,25 @@ import (
 )
 
 type tomeMetadata struct {
+	Name        string
 	Description string
+	ParamDefs   []interface{}
+}
+
+func convert_yaml_to_json(i interface{}) interface{} {
+	switch x := i.(type) {
+	case map[interface{}]interface{}:
+		m2 := map[string]interface{}{}
+		for k, v := range x {
+			m2[k.(string)] = convert_yaml_to_json(v)
+		}
+		return m2
+	case []interface{}:
+		for i, v := range x {
+			x[i] = convert_yaml_to_json(v)
+		}
+	}
+	return i
 }
 
 // UploadTomes traverses the provided filesystem and creates tomes using the provided graph.
@@ -92,10 +111,16 @@ func UploadTomes(ctx context.Context, graph *ent.Client, fileSystem fs.ReadDirFS
 			return rollback(tx, fmt.Errorf("failed to parse and upload tome %q: %w", entry.Name(), err))
 		}
 
+		jsonified_paramdefs, err := json.Marshal(convert_yaml_to_json(metadata.ParamDefs))
+		if err != nil {
+			return rollback(tx, fmt.Errorf("failed to prase param defs for %q: %w", metadata.Name, err))
+		}
+
 		// Create the tome
 		if _, err := graph.Tome.Create().
 			SetName(entry.Name()).
 			SetDescription(metadata.Description).
+			SetParamDefs(string(jsonified_paramdefs)).
 			SetEldritch(eldritch).
 			AddFiles(tomeFiles...).
 			Save(ctx); err != nil {

diff --git a/tavern/tomes/parse_test.go b/tavern/tomes/parse_test.go
@@ -25,11 +25,12 @@ func TestUploadTomes(t *testing.T) {
 		Where(tome.Name("example")).
 		OnlyX(ctx)
 	require.NotNil(t, testTome)
-	assert.Equal(t, `print("Hello World")`, testTome.Eldritch)
+	assert.Equal(t, `print(input_params['msg'])`, testTome.Eldritch)
 	assert.Equal(t, `An example tome!`, testTome.Description)
+	assert.Equal(t, `[{"label":"Message","name":"msg","placeholder":"Something to print","type":"string"}]`, testTome.ParamDefs)
 	testTomeFiles, err := testTome.Files(ctx)
 	assert.NoError(t, err)
 	assert.Len(t, testTomeFiles, 1)
-	assert.Equal(t, "example/linux/test-implant", testTomeFiles[0].Name)
-	assert.Equal(t, []byte("meowware"), testTomeFiles[0].Content)
+	assert.Equal(t, "example/linux/test-file", testTomeFiles[0].Name)
+	assert.Equal(t, []byte("This file exists "), testTomeFiles[0].Content)
 }
-Original file line number
+Diff line change
@@ Expand Up @@
             };
             input_params.insert_hashed(hashed_key, new_value);
         }
         module.set("input_params", input_params.alloc_value(module.heap()));
         let mut eval: Evaluator = Evaluator::new(&module);
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>React App</title><script defer="defer" src="/static/js/main.d00b684e.js"></script><link href="/static/css/main.d3a1f05a.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
		<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><meta name="description" content="Web site created using create-react-app"/><link rel="apple-touch-icon" href="/logo192.png"/><link rel="manifest" href="/manifest.json"/><title>React App</title><script defer="defer" src="/static/js/main.dce5904d.js"></script><link href="/static/css/main.d3a1f05a.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>