mirror of
https://github.com/danielmiessler/Fabric.git
synced 2026-01-10 23:08:06 -05:00
Compare commits
117 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e858700976 | ||
|
|
525b89be71 | ||
|
|
7a26012457 | ||
|
|
a5929fcad6 | ||
|
|
ad561248fd | ||
|
|
edb4490c86 | ||
|
|
70c9746bcb | ||
|
|
ba774d26c6 | ||
|
|
2e2177e26b | ||
|
|
72ec02bfd4 | ||
|
|
9b94518e20 | ||
|
|
b550936e72 | ||
|
|
ce2d6def36 | ||
|
|
1977c6260a | ||
|
|
811e4c84ab | ||
|
|
104513f72b | ||
|
|
e434999802 | ||
|
|
fce06b5294 | ||
|
|
c53f160ab8 | ||
|
|
4100ace659 | ||
|
|
1e7ae9790c | ||
|
|
ac1fc4b1d6 | ||
|
|
79b23f3106 | ||
|
|
6d00405eb6 | ||
|
|
65285fdef0 | ||
|
|
89edd7152a | ||
|
|
5527dc8db5 | ||
|
|
f5ac7fd92c | ||
|
|
61027f30a4 | ||
|
|
575f83954d | ||
|
|
ae18e9d1c7 | ||
|
|
76d18e2f04 | ||
|
|
978731f385 | ||
|
|
103388ecec | ||
|
|
53ea7ab126 | ||
|
|
b008d17b6e | ||
|
|
2ba294f4d6 | ||
|
|
a7ed257fe3 | ||
|
|
9a9990f78c | ||
|
|
95f0c95832 | ||
|
|
3b1b0385e1 | ||
|
|
621b64c89f | ||
|
|
1ce5bd4447 | ||
|
|
634cd3f484 | ||
|
|
8f4aab4f61 | ||
|
|
12284ad3db | ||
|
|
f180e8fc6b | ||
|
|
89153dd235 | ||
|
|
aa2881f3c2 | ||
|
|
82379ee6ec | ||
|
|
e795055d13 | ||
|
|
5b6d7e27b6 | ||
|
|
c6dc13ef7f | ||
|
|
7e6a760623 | ||
|
|
01519d7486 | ||
|
|
f5f50cc4c9 | ||
|
|
9226e95d18 | ||
|
|
2d8b46b878 | ||
|
|
fbd6083079 | ||
|
|
0320e17652 | ||
|
|
09fb913279 | ||
|
|
ec5ed689bb | ||
|
|
373c1d0858 | ||
|
|
ca55f2375d | ||
|
|
d8671ea03a | ||
|
|
c49f47ecab | ||
|
|
43ca0dccf7 | ||
|
|
fcfcf55610 | ||
|
|
188235efc5 | ||
|
|
fdd1d614b2 | ||
|
|
6fc75282e8 | ||
|
|
fc67dea243 | ||
|
|
efd363d5fb | ||
|
|
a7d6de1661 | ||
|
|
d17afc1fba | ||
|
|
da6f974887 | ||
|
|
db2ba46099 | ||
|
|
744ec0824b | ||
|
|
b31f094e9b | ||
|
|
43597e4168 | ||
|
|
160703210b | ||
|
|
c0ade48648 | ||
|
|
7fd4fa4742 | ||
|
|
41b2e66c5c | ||
|
|
ed657383fb | ||
|
|
4d5d8d8b30 | ||
|
|
e9a75528ab | ||
|
|
c5ec4b548a | ||
|
|
8e87529638 | ||
|
|
ca33208fa1 | ||
|
|
3f8bca8728 | ||
|
|
ba56c33cf6 | ||
|
|
6ee4fdd366 | ||
|
|
30af189ae3 | ||
|
|
be998ff588 | ||
|
|
6bb3238e6d | ||
|
|
dfcd29593d | ||
|
|
63b357168e | ||
|
|
317a4309f7 | ||
|
|
eceb10b725 | ||
|
|
34f508fd82 | ||
|
|
9fa8634083 | ||
|
|
a3ea63c1f9 | ||
|
|
097b3eb0ba | ||
|
|
30f37ea633 | ||
|
|
23b495c8f7 | ||
|
|
e7f2d48437 | ||
|
|
7043f78f1f | ||
|
|
f2cc718f49 | ||
|
|
edb814c9f0 | ||
|
|
21de69b7d9 | ||
|
|
d4b5c3b8d5 | ||
|
|
afb5857699 | ||
|
|
153b8217fd | ||
|
|
beeba6989a | ||
|
|
b758a27b93 | ||
|
|
81d765a34c |
@@ -63,6 +63,10 @@ jobs:
|
||||
- name: Update version.nix file
|
||||
run: |
|
||||
echo "\"${{ env.new_version }}\"" > pkgs/fabric/version.nix
|
||||
|
||||
- name: Format source codes
|
||||
run: |
|
||||
go fmt ./...
|
||||
|
||||
- name: Update gomod2nix.toml file
|
||||
run: |
|
||||
@@ -73,6 +77,7 @@ jobs:
|
||||
git add version.go
|
||||
git add pkgs/fabric/version.nix
|
||||
git add gomod2nix.toml
|
||||
git add .
|
||||
if ! git diff --staged --quiet; then
|
||||
git commit -m "Update version to ${{ env.new_tag }} and commit $commit_hash"
|
||||
else
|
||||
|
||||
178
.gitignore
vendored
178
.gitignore
vendored
@@ -22,7 +22,7 @@ dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
@@ -166,3 +166,179 @@ cython_debug/
|
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
||||
#.idea/
|
||||
|
||||
patterns/dialog_with_socrates/Apology by Plato.txt
|
||||
patterns/dialog_with_socrates/Phaedrus by Plato.txt
|
||||
patterns/dialog_with_socrates/Symposium by Plato.txt
|
||||
patterns/dialog_with_socrates/The Economist by Xenophon.txt
|
||||
patterns/dialog_with_socrates/The Memorabilia by Xenophon.txt
|
||||
patterns/dialog_with_socrates/The Memorable Thoughts of Socrates by Xenophon.txt
|
||||
patterns/dialog_with_socrates/The Republic by Plato.txt
|
||||
patterns/dialog_with_socrates/The Symposium by Xenophon.txt
|
||||
|
||||
web/node_modules
|
||||
|
||||
# Output
|
||||
web/.output
|
||||
web/.vercel
|
||||
web/.svelte-kit
|
||||
web/build
|
||||
|
||||
# OS
|
||||
web/.DS_Store
|
||||
web/Thumbs.db
|
||||
|
||||
# Env
|
||||
web/.env
|
||||
web/.env.*
|
||||
web/!.env.example
|
||||
web/!.env.test
|
||||
|
||||
# Vite
|
||||
web/vite.config.js.timestamp-*
|
||||
web/vite.config.ts.timestamp-*
|
||||
# Created by https://www.toptal.com/developers/gitignore/api/node
|
||||
# Edit at https://www.toptal.com/developers/gitignore?templates=node
|
||||
|
||||
### Node ###
|
||||
# Logs
|
||||
web/logs
|
||||
web/*.log
|
||||
web/npm-debug.log*
|
||||
web/yarn-debug.log*
|
||||
web/yarn-error.log*
|
||||
web/lerna-debug.log*
|
||||
web/.pnpm-debug.log*
|
||||
|
||||
# Diagnostic reports (https://nodejs.org/api/report.html)
|
||||
web/report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
||||
|
||||
# Runtime data
|
||||
web/pids
|
||||
web/*.pid
|
||||
web/*.seed
|
||||
web/*.pid.lock
|
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||
web/lib-cov
|
||||
|
||||
# Coverage directory used by tools like istanbul
|
||||
web/coverage
|
||||
web/*.lcov
|
||||
|
||||
# nyc test coverage
|
||||
web/.nyc_output
|
||||
|
||||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||
web/.grunt
|
||||
|
||||
# Bower dependency directory (https://bower.io/)
|
||||
web/bower_components
|
||||
|
||||
# node-waf configuration
|
||||
web/.lock-wscript
|
||||
|
||||
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||
build/Release
|
||||
|
||||
# Dependency directories
|
||||
web/node_modules/
|
||||
jspm_packages/
|
||||
|
||||
# Snowpack dependency directory (https://snowpack.dev/)
|
||||
web/web_modules/
|
||||
|
||||
# TypeScript cache
|
||||
*.tsbuildinfo
|
||||
|
||||
# Optional npm cache directory
|
||||
web/.npm
|
||||
|
||||
# Optional eslint cache
|
||||
web/.eslintcache
|
||||
|
||||
# Optional stylelint cache
|
||||
web/.stylelintcache
|
||||
|
||||
# Microbundle cache
|
||||
web/.rpt2_cache/
|
||||
web/.rts2_cache_cjs/
|
||||
web/.rts2_cache_es/
|
||||
web/.rts2_cache_umd/
|
||||
|
||||
# Optional REPL history
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
.yarn-integrity
|
||||
|
||||
# dotenv environment variable files
|
||||
web/.env
|
||||
web/.env.development.local
|
||||
web/.env.test.local
|
||||
web/.env.production.local
|
||||
web/.env.local
|
||||
|
||||
# parcel-bundler cache (https://parceljs.org/)
|
||||
.cache
|
||||
.parcel-cache
|
||||
|
||||
# Next.js build output
|
||||
web/.next
|
||||
web/out
|
||||
|
||||
# Nuxt.js build / generate output
|
||||
web/.nuxt
|
||||
web/dist
|
||||
|
||||
# Gatsby files
|
||||
web/.cache/
|
||||
# Comment in the public line in if your project uses Gatsby and not Next.js
|
||||
# https://nextjs.org/blog/next-9-1#public-directory-support
|
||||
# public
|
||||
|
||||
# vuepress build output
|
||||
web/.vuepress/dist
|
||||
|
||||
# vuepress v2.x temp and cache directory
|
||||
web/.temp
|
||||
|
||||
# Docusaurus cache and generated files
|
||||
.docusaurus
|
||||
|
||||
# Serverless directories
|
||||
.serverless/
|
||||
|
||||
# FuseBox cache
|
||||
.fusebox/
|
||||
|
||||
# DynamoDB Local files
|
||||
.dynamodb/
|
||||
|
||||
# TernJS port file
|
||||
.tern-port
|
||||
|
||||
# Stores VSCode versions used for testing VSCode extensions
|
||||
web/.vscode-test
|
||||
|
||||
# yarn v2
|
||||
web/.yarn/cache
|
||||
web/.yarn/unplugged
|
||||
web/.yarn/build-state.yml
|
||||
web/.yarn/install-state.gz
|
||||
web/.pnp.*
|
||||
|
||||
### Node Patch ###
|
||||
# Serverless Webpack directories
|
||||
web/.webpack/
|
||||
|
||||
# Optional stylelint cache
|
||||
|
||||
# SvelteKit build / generate output
|
||||
web/.svelte-kit
|
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/node
|
||||
|
||||
|
||||
75
README.md
75
README.md
@@ -26,6 +26,7 @@
|
||||
[Meta](#meta)
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
|
||||
## Navigation
|
||||
@@ -56,6 +57,7 @@
|
||||
- [`to_pdf`](#to_pdf)
|
||||
- [`to_pdf` Installation](#to_pdf-installation)
|
||||
- [pbpaste](#pbpaste)
|
||||
- [Web Interface](#Web_Interface)
|
||||
- [Meta](#meta)
|
||||
- [Primary contributors](#primary-contributors)
|
||||
|
||||
@@ -64,9 +66,9 @@
|
||||
## Updates
|
||||
|
||||
> [!NOTE]
|
||||
November 8, 2024
|
||||
> * **Multimodal Support**: You can now us `-a` (attachment) for Multimodal submissions to OpenAI models that support it. Example: `fabric -a https://path/to/image "Give me a description of this image."`
|
||||
|
||||
> November 8, 2024
|
||||
>
|
||||
> - **Multimodal Support**: You can now use `-a` (attachment) for Multimodal submissions to OpenAI models that support it. Example: `fabric -a https://path/to/image "Give me a description of this image."`
|
||||
|
||||
## What and why
|
||||
|
||||
@@ -82,10 +84,10 @@ Fabric was created to address this by enabling everyone to granularly apply AI t
|
||||
|
||||
Keep in mind that many of these were recorded when Fabric was Python-based, so remember to use the current [install instructions](#Installation) below.
|
||||
|
||||
* [Network Chuck](https://www.youtube.com/watch?v=UbDyjIIGaxQ)
|
||||
* [David Bombal](https://www.youtube.com/watch?v=vF-MQmVxnCs)
|
||||
* [My Own Intro to the Tool](https://www.youtube.com/watch?v=wPEyyigh10g)
|
||||
* [More Fabric YouTube Videos](https://www.youtube.com/results?search_query=fabric+ai)
|
||||
- [Network Chuck](https://www.youtube.com/watch?v=UbDyjIIGaxQ)
|
||||
- [David Bombal](https://www.youtube.com/watch?v=vF-MQmVxnCs)
|
||||
- [My Own Intro to the Tool](https://www.youtube.com/watch?v=wPEyyigh10g)
|
||||
- [More Fabric YouTube Videos](https://www.youtube.com/results?search_query=fabric+ai)
|
||||
|
||||
## Philosophy
|
||||
|
||||
@@ -155,6 +157,7 @@ go install github.com/danielmiessler/fabric@latest
|
||||
You may need to set some environment variables in your `~/.bashrc` on linux or `~/.zshrc` file on mac to be able to run the `fabric` command. Here is an example of what you can add:
|
||||
|
||||
For Intel based macs or linux
|
||||
|
||||
```bash
|
||||
# Golang environment variables
|
||||
export GOROOT=/usr/local/go
|
||||
@@ -165,6 +168,7 @@ export PATH=$GOPATH/bin:$GOROOT/bin:$HOME/.local/bin:$PATH
|
||||
```
|
||||
|
||||
for Apple Silicon based macs
|
||||
|
||||
```bash
|
||||
# Golang environment variables
|
||||
export GOROOT=$(brew --prefix go)/libexec
|
||||
@@ -173,14 +177,18 @@ export PATH=$GOPATH/bin:$GOROOT/bin:$HOME/.local/bin:$PATH
|
||||
```
|
||||
|
||||
### Setup
|
||||
|
||||
Now run the following command
|
||||
|
||||
```bash
|
||||
# Run the setup to set up your directories and keys
|
||||
fabric --setup
|
||||
```
|
||||
|
||||
If everything works you are good to go.
|
||||
|
||||
### Add aliases for all patterns
|
||||
|
||||
In order to add aliases for all your patterns and use them directly as commands ie. `summarize` instead of `fabric --pattern summarize`
|
||||
You can add the following to your `.zshrc` or `.bashrc` file.
|
||||
|
||||
@@ -189,10 +197,10 @@ You can add the following to your `.zshrc` or `.bashrc` file.
|
||||
for pattern_file in $HOME/.config/fabric/patterns/*; do
|
||||
# Get the base name of the file (i.e., remove the directory path)
|
||||
pattern_name=$(basename "$pattern_file")
|
||||
|
||||
|
||||
# Create an alias in the form: alias pattern_name="fabric --pattern pattern_name"
|
||||
alias_command="alias $pattern_name='fabric --pattern $pattern_name'"
|
||||
|
||||
|
||||
# Evaluate the alias command to add it to the current shell
|
||||
eval "$alias_command"
|
||||
done
|
||||
@@ -202,9 +210,11 @@ yt() {
|
||||
fabric -y "$video_link" --transcript
|
||||
}
|
||||
```
|
||||
|
||||
This also creates a `yt` alias that allows you to use `yt https://www.youtube.com/watch?v=4b0iet22VIk` to get your transcripts.
|
||||
|
||||
#### Save your files in markdown using aliases
|
||||
|
||||
If in addition to the above aliases you would like to have the option to save the output to your favourite markdown note vault like Obsidian then instead of the above add the following to your `.zshrc` or `.bashrc` file:
|
||||
|
||||
```bash
|
||||
@@ -244,7 +254,7 @@ yt() {
|
||||
}
|
||||
```
|
||||
|
||||
This will allow you to use the patterns as aliases like in the above for example `summarize` instead of `fabric --pattern summarize --stream`, however if you pass in an extra argument like this `summarize "my_article_title"` your output will be saved in the destination that you set in `obsidian_base="/path/to/obsidian"` in the following format `YYYY-MM-DD-my_article_title.md` where the date gets autogenerated for you.
|
||||
This will allow you to use the patterns as aliases like in the above for example `summarize` instead of `fabric --pattern summarize --stream`, however if you pass in an extra argument like this `summarize "my_article_title"` your output will be saved in the destination that you set in `obsidian_base="/path/to/obsidian"` in the following format `YYYY-MM-DD-my_article_title.md` where the date gets autogenerated for you.
|
||||
You can tweak the date format by tweaking the `date_stamp` format.
|
||||
|
||||
### Migration
|
||||
@@ -268,11 +278,13 @@ Then [set your environmental variables](#environmental-variables) as shown above
|
||||
### Upgrading
|
||||
|
||||
The great thing about Go is that it's super easy to upgrade. Just run the same command you used to install it in the first place and you'll always get the latest version.
|
||||
|
||||
```bash
|
||||
go install github.com/danielmiessler/fabric@latest
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Once you have it all set up, here's how to use it.
|
||||
|
||||
```bash
|
||||
@@ -320,6 +332,7 @@ Application Options:
|
||||
--printcontext= Print context
|
||||
--printsession= Print session
|
||||
--readability Convert HTML input into a clean, readable view
|
||||
--serve Initiate the API server
|
||||
--dry-run Show what would be sent to the model without actually sending it
|
||||
--version Print current version
|
||||
|
||||
@@ -401,7 +414,6 @@ When you're ready to use them, copy them into:
|
||||
|
||||
You can then use them like any other Patterns, but they won't be public unless you explicitly submit them as Pull Requests to the Fabric project. So don't worry—they're private to you.
|
||||
|
||||
|
||||
This feature works with all openai and ollama models but does NOT work with claude. You can specify your model with the -m flag
|
||||
|
||||
## Helper Apps
|
||||
@@ -459,6 +471,46 @@ You can also create an alias by editing `~/.bashrc` or `~/.zshrc` and adding the
|
||||
alias pbpaste='xclip -selection clipboard -o'
|
||||
```
|
||||
|
||||
## Web Interface
|
||||
|
||||
Fabric now includes a built-in web interface that provides a GUI alternative to the command-line interface and an out-of-the-box website for those who want to get started with web development or blogging.
|
||||
You can use this app as a GUI interface for Fabric, a ready to go blog-site, or a website template for your own projects.
|
||||
|
||||
The `web/src/lib/content` directory includes starter `.obsidian/` and `templates/` directories, allowing you to open up the `web/src/lib/content/` directory as an [Obsidian.md](https://obsidian.md) vault. You can place your posts in the posts directory when you're ready to publish.
|
||||
### Installing
|
||||
|
||||
The GUI can be installed by navigating to the `web` directory and using `npm install`, `pnpm install`, or your favorite package manager. Then simply run the development server to start the app.
|
||||
|
||||
_You will need to run fabric in a separate terminal with the `fabric --serve` command._
|
||||
|
||||
**From the fabric project `web/` directory:**
|
||||
```shell
|
||||
npm run dev
|
||||
|
||||
## or ##
|
||||
|
||||
pnpm run dev
|
||||
|
||||
## or your equivalent
|
||||
```
|
||||
|
||||
### Streamlit UI
|
||||
|
||||
To run the Streamlit user interface:
|
||||
|
||||
```bash
|
||||
# Install required dependencies
|
||||
pip install streamlit pandas matplotlib seaborn numpy python-dotenv
|
||||
|
||||
# Run the Streamlit app
|
||||
streamlit run streamlit.py
|
||||
```
|
||||
|
||||
The Streamlit UI provides a user-friendly interface for:
|
||||
- Running and chaining patterns
|
||||
- Managing pattern outputs
|
||||
- Creating and editing patterns
|
||||
- Analyzing pattern results
|
||||
## Meta
|
||||
|
||||
> [!NOTE]
|
||||
@@ -467,6 +519,7 @@ alias pbpaste='xclip -selection clipboard -o'
|
||||
- _Jonathan Dunn_ for being the absolute MVP dev on the project, including spearheading the new Go version, as well as the GUI! All this while also being a full-time medical doctor!
|
||||
- _Caleb Sima_ for pushing me over the edge of whether to make this a public project or not.
|
||||
- _Eugen Eisler_ and _Frederick Ros_ for their invaluable contributions to the Go version
|
||||
- _David Peters_ for his work on the web interface.
|
||||
- _Joel Parish_ for super useful input on the project's Github directory structure..
|
||||
- _Joseph Thacker_ for the idea of a `-c` context flag that adds pre-created context in the `./config/fabric/` directory to all Pattern queries.
|
||||
- _Jason Haddix_ for the idea of a stitch (chained Pattern) to filter content using a local model before sending on to a cloud model, i.e., cleaning customer data using `llama2` before sending on to `gpt-4` for analysis.
|
||||
|
||||
68
cli/README.md
Normal file
68
cli/README.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# YAML Configuration Support
|
||||
|
||||
## Overview
|
||||
Fabric now supports YAML configuration files for commonly used options. This allows users to persist settings and share configurations across multiple runs.
|
||||
|
||||
## Usage
|
||||
Use the `--config` flag to specify a YAML configuration file:
|
||||
```bash
|
||||
fabric --config ~/.config/fabric/config.yaml "Tell me about APIs"
|
||||
```
|
||||
|
||||
## Configuration Precedence
|
||||
1. CLI flags (highest priority)
|
||||
2. YAML config values
|
||||
3. Default values (lowest priority)
|
||||
|
||||
## Supported Configuration Options
|
||||
```yaml
|
||||
# Model selection
|
||||
model: gpt-4
|
||||
modelContextLength: 4096
|
||||
|
||||
# Model parameters
|
||||
temperature: 0.7
|
||||
topp: 0.9
|
||||
presencepenalty: 0.0
|
||||
frequencypenalty: 0.0
|
||||
seed: 42
|
||||
|
||||
# Pattern selection
|
||||
pattern: analyze # Use pattern name or filename
|
||||
|
||||
# Feature flags
|
||||
stream: true
|
||||
raw: false
|
||||
```
|
||||
|
||||
## Rules and Behavior
|
||||
- Only long flag names are supported in YAML (e.g., `temperature` not `-t`)
|
||||
- CLI flags always override YAML values
|
||||
- Unknown YAML declarations are ignored
|
||||
- If a declaration appears multiple times in YAML, the last one wins
|
||||
- The order of YAML declarations doesn't matter
|
||||
|
||||
## Type Conversions
|
||||
The following string-to-type conversions are supported:
|
||||
- String to number: `"42"` → `42`
|
||||
- String to float: `"42.5"` → `42.5`
|
||||
- String to boolean: `"true"` → `true`
|
||||
|
||||
## Example Config
|
||||
```yaml
|
||||
# ~/.config/fabric/config.yaml
|
||||
model: gpt-4
|
||||
temperature: 0.8
|
||||
pattern: analyze
|
||||
stream: true
|
||||
topp: 0.95
|
||||
presencepenalty: 0.1
|
||||
frequencypenalty: 0.2
|
||||
```
|
||||
|
||||
## CLI Override Example
|
||||
```bash
|
||||
# Override temperature from config
|
||||
fabric --config ~/.config/fabric/config.yaml --temperature 0.9 "Query"
|
||||
```
|
||||
|
||||
30
cli/cli.go
30
cli/cli.go
@@ -2,12 +2,13 @@ package cli
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/youtube"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/danielmiessler/fabric/plugins/tools/youtube"
|
||||
|
||||
"github.com/danielmiessler/fabric/common"
|
||||
"github.com/danielmiessler/fabric/core"
|
||||
"github.com/danielmiessler/fabric/plugins/ai"
|
||||
@@ -42,7 +43,10 @@ func Cli(version string) (err error) {
|
||||
}
|
||||
}
|
||||
|
||||
registry := core.NewPluginRegistry(fabricDb)
|
||||
var registry *core.PluginRegistry
|
||||
if registry, err = core.NewPluginRegistry(fabricDb); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// if the setup flag is set, run the setup function
|
||||
if currentFlags.Setup {
|
||||
@@ -51,10 +55,17 @@ func Cli(version string) (err error) {
|
||||
}
|
||||
|
||||
if currentFlags.Serve {
|
||||
registry.ConfigureVendors()
|
||||
err = restapi.Serve(registry, currentFlags.ServeAddress)
|
||||
return
|
||||
}
|
||||
|
||||
if currentFlags.ServeOllama {
|
||||
registry.ConfigureVendors()
|
||||
err = restapi.ServeOllama(registry, currentFlags.ServeAddress, version)
|
||||
return
|
||||
}
|
||||
|
||||
if currentFlags.UpdatePatterns {
|
||||
err = registry.PatternsLoader.PopulateDB()
|
||||
return
|
||||
@@ -129,6 +140,21 @@ func Cli(version string) (err error) {
|
||||
}
|
||||
}
|
||||
|
||||
if currentFlags.ListExtensions {
|
||||
err = registry.TemplateExtensions.ListExtensions()
|
||||
return
|
||||
}
|
||||
|
||||
if currentFlags.AddExtension != "" {
|
||||
err = registry.TemplateExtensions.RegisterExtension(currentFlags.AddExtension)
|
||||
return
|
||||
}
|
||||
|
||||
if currentFlags.RemoveExtension != "" {
|
||||
err = registry.TemplateExtensions.RemoveExtension(currentFlags.RemoveExtension)
|
||||
return
|
||||
}
|
||||
|
||||
// if the interactive flag is set, run the interactive function
|
||||
// if currentFlags.Interactive {
|
||||
// interactive.Interactive()
|
||||
|
||||
21
cli/example.yaml
Normal file
21
cli/example.yaml
Normal file
@@ -0,0 +1,21 @@
|
||||
#this is an example yaml config file for fabric
|
||||
|
||||
# use fabric pattern names
|
||||
pattern: ai
|
||||
|
||||
# or use a filename
|
||||
# pattern: ~/testpattern.md
|
||||
|
||||
model: phi3:latest
|
||||
|
||||
# for models that support context length
|
||||
modelContextLength: 2048
|
||||
|
||||
frequencypenalty: 0.5
|
||||
presencepenalty: 0.5
|
||||
topp: 0.67
|
||||
temperature: 0.88
|
||||
seed: 42
|
||||
|
||||
stream: true
|
||||
raw: false
|
||||
182
cli/flags.go
182
cli/flags.go
@@ -6,29 +6,32 @@ import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"reflect"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/jessevdk/go-flags"
|
||||
goopenai "github.com/sashabaranov/go-openai"
|
||||
"golang.org/x/text/language"
|
||||
"gopkg.in/yaml.v2"
|
||||
|
||||
"github.com/danielmiessler/fabric/common"
|
||||
)
|
||||
|
||||
// Flags create flags struct. the users flags go into this, this will be passed to the chat struct in cli
|
||||
type Flags struct {
|
||||
Pattern string `short:"p" long:"pattern" description:"Choose a pattern from the available patterns" default:""`
|
||||
Pattern string `short:"p" long:"pattern" yaml:"pattern" description:"Choose a pattern from the available patterns" default:""`
|
||||
PatternVariables map[string]string `short:"v" long:"variable" description:"Values for pattern variables, e.g. -v=#role:expert -v=#points:30"`
|
||||
Context string `short:"C" long:"context" description:"Choose a context from the available contexts" default:""`
|
||||
Session string `long:"session" description:"Choose a session from the available sessions"`
|
||||
Attachments []string `short:"a" long:"attachment" description:"Attachment path or URL (e.g. for OpenAI image recognition messages)"`
|
||||
Setup bool `short:"S" long:"setup" description:"Run setup for all reconfigurable parts of fabric"`
|
||||
Temperature float64 `short:"t" long:"temperature" description:"Set temperature" default:"0.7"`
|
||||
TopP float64 `short:"T" long:"topp" description:"Set top P" default:"0.9"`
|
||||
Stream bool `short:"s" long:"stream" description:"Stream"`
|
||||
PresencePenalty float64 `short:"P" long:"presencepenalty" description:"Set presence penalty" default:"0.0"`
|
||||
Raw bool `short:"r" long:"raw" description:"Use the defaults of the model without sending chat options (like temperature etc.) and use the user role instead of the system role for patterns."`
|
||||
FrequencyPenalty float64 `short:"F" long:"frequencypenalty" description:"Set frequency penalty" default:"0.0"`
|
||||
Temperature float64 `short:"t" long:"temperature" yaml:"temperature" description:"Set temperature" default:"0.7"`
|
||||
TopP float64 `short:"T" long:"topp" yaml:"topp" description:"Set top P" default:"0.9"`
|
||||
Stream bool `short:"s" long:"stream" yaml:"stream" description:"Stream"`
|
||||
PresencePenalty float64 `short:"P" long:"presencepenalty" yaml:"presencepenalty" description:"Set presence penalty" default:"0.0"`
|
||||
Raw bool `short:"r" long:"raw" yaml:"raw" description:"Use the defaults of the model without sending chat options (like temperature etc.) and use the user role instead of the system role for patterns."`
|
||||
FrequencyPenalty float64 `short:"F" long:"frequencypenalty" yaml:"frequencypenalty" description:"Set frequency penalty" default:"0.0"`
|
||||
ListPatterns bool `short:"l" long:"listpatterns" description:"List all patterns"`
|
||||
ListAllModels bool `short:"L" long:"listmodels" description:"List all available models"`
|
||||
ListAllContexts bool `short:"x" long:"listcontexts" description:"List all contexts"`
|
||||
@@ -36,8 +39,8 @@ type Flags struct {
|
||||
UpdatePatterns bool `short:"U" long:"updatepatterns" description:"Update patterns"`
|
||||
Message string `hidden:"true" description:"Messages to send to chat"`
|
||||
Copy bool `short:"c" long:"copy" description:"Copy to clipboard"`
|
||||
Model string `short:"m" long:"model" description:"Choose model"`
|
||||
ModelContextLength int `long:"modelContextLength" description:"Model context length (only affects ollama)"`
|
||||
Model string `short:"m" long:"model" yaml:"model" description:"Choose model"`
|
||||
ModelContextLength int `long:"modelContextLength" yaml:"modelContextLength" description:"Model context length (only affects ollama)"`
|
||||
Output string `short:"o" long:"output" description:"Output to file" default:""`
|
||||
OutputSession bool `long:"output-session" description:"Output the entire session (also a temporary one) to the output file"`
|
||||
LatestPatterns string `short:"n" long:"latest" description:"Number of latest patterns to list" default:"0"`
|
||||
@@ -49,48 +52,180 @@ type Flags struct {
|
||||
Language string `short:"g" long:"language" description:"Specify the Language Code for the chat, e.g. -g=en -g=zh" default:""`
|
||||
ScrapeURL string `short:"u" long:"scrape_url" description:"Scrape website URL to markdown using Jina AI"`
|
||||
ScrapeQuestion string `short:"q" long:"scrape_question" description:"Search question using Jina AI"`
|
||||
Seed int `short:"e" long:"seed" description:"Seed to be used for LMM generation"`
|
||||
Seed int `short:"e" long:"seed" yaml:"seed" description:"Seed to be used for LMM generation"`
|
||||
WipeContext string `short:"w" long:"wipecontext" description:"Wipe context"`
|
||||
WipeSession string `short:"W" long:"wipesession" description:"Wipe session"`
|
||||
PrintContext string `long:"printcontext" description:"Print context"`
|
||||
PrintSession string `long:"printsession" description:"Print session"`
|
||||
HtmlReadability bool `long:"readability" description:"Convert HTML input into a clean, readable view"`
|
||||
InputHasVars bool `long:"input-has-vars" description:"Apply variables to user input"`
|
||||
DryRun bool `long:"dry-run" description:"Show what would be sent to the model without actually sending it"`
|
||||
Serve bool `long:"serve" description:"Serve the Fabric Rest API"`
|
||||
ServeOllama bool `long:"serveOllama" description:"Serve the Fabric Rest API with ollama endpoints"`
|
||||
ServeAddress string `long:"address" description:"The address to bind the REST API" default:":8080"`
|
||||
Config string `long:"config" description:"Path to YAML config file"`
|
||||
Version bool `long:"version" description:"Print current version"`
|
||||
ListExtensions bool `long:"listextensions" description:"List all registered extensions"`
|
||||
AddExtension string `long:"addextension" description:"Register a new extension from config file path"`
|
||||
RemoveExtension string `long:"rmextension" description:"Remove a registered extension by name"`
|
||||
}
|
||||
|
||||
var debug = false
|
||||
|
||||
func Debugf(format string, a ...interface{}) {
|
||||
if debug {
|
||||
fmt.Printf("DEBUG: "+format, a...)
|
||||
}
|
||||
}
|
||||
|
||||
// Init Initialize flags. returns a Flags struct and an error
|
||||
func Init() (ret *Flags, err error) {
|
||||
var message string
|
||||
// Track which yaml-configured flags were set on CLI
|
||||
usedFlags := make(map[string]bool)
|
||||
yamlArgsScan := os.Args[1:]
|
||||
|
||||
// Get list of fields that have yaml tags, could be in yaml config
|
||||
yamlFields := make(map[string]bool)
|
||||
t := reflect.TypeOf(Flags{})
|
||||
for i := 0; i < t.NumField(); i++ {
|
||||
if yamlTag := t.Field(i).Tag.Get("yaml"); yamlTag != "" {
|
||||
yamlFields[yamlTag] = true
|
||||
//Debugf("Found yaml-configured field: %s\n", yamlTag)
|
||||
}
|
||||
}
|
||||
|
||||
// Scan args for that are provided by cli and might be in yaml
|
||||
for _, arg := range yamlArgsScan {
|
||||
if strings.HasPrefix(arg, "--") {
|
||||
flag := strings.TrimPrefix(arg, "--")
|
||||
if i := strings.Index(flag, "="); i > 0 {
|
||||
flag = flag[:i]
|
||||
}
|
||||
if yamlFields[flag] {
|
||||
usedFlags[flag] = true
|
||||
Debugf("CLI flag used: %s\n", flag)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Parse CLI flags first
|
||||
ret = &Flags{}
|
||||
parser := flags.NewParser(ret, flags.Default)
|
||||
var args []string
|
||||
if args, err = parser.Parse(); err != nil {
|
||||
return
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// If config specified, load and apply YAML for unused flags
|
||||
if ret.Config != "" {
|
||||
yamlFlags, err := loadYAMLConfig(ret.Config)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Apply YAML values where CLI flags weren't used
|
||||
flagsVal := reflect.ValueOf(ret).Elem()
|
||||
yamlVal := reflect.ValueOf(yamlFlags).Elem()
|
||||
flagsType := flagsVal.Type()
|
||||
|
||||
for i := 0; i < flagsType.NumField(); i++ {
|
||||
field := flagsType.Field(i)
|
||||
if yamlTag := field.Tag.Get("yaml"); yamlTag != "" {
|
||||
if !usedFlags[yamlTag] {
|
||||
flagField := flagsVal.Field(i)
|
||||
yamlField := yamlVal.Field(i)
|
||||
if flagField.CanSet() {
|
||||
if yamlField.Type() != flagField.Type() {
|
||||
if err := assignWithConversion(flagField, yamlField); err != nil {
|
||||
Debugf("Type conversion failed for %s: %v\n", yamlTag, err)
|
||||
continue
|
||||
}
|
||||
} else {
|
||||
flagField.Set(yamlField)
|
||||
}
|
||||
Debugf("Applied YAML value for %s: %v\n", yamlTag, yamlField.Interface())
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Handle stdin and messages
|
||||
info, _ := os.Stdin.Stat()
|
||||
pipedToStdin := (info.Mode() & os.ModeCharDevice) == 0
|
||||
|
||||
// takes input from stdin if it exists, otherwise takes input from args (the last argument)
|
||||
// Append positional arguments to the message (custom message)
|
||||
if len(args) > 0 {
|
||||
ret.Message = AppendMessage(ret.Message, args[len(args)-1])
|
||||
}
|
||||
|
||||
if pipedToStdin {
|
||||
//fmt.Printf("piped: %v\n", args)
|
||||
if message, err = readStdin(); err != nil {
|
||||
var pipedMessage string
|
||||
if pipedMessage, err = readStdin(); err != nil {
|
||||
return
|
||||
}
|
||||
} else if len(args) > 0 {
|
||||
//fmt.Printf("no piped: %v\n", args)
|
||||
message = args[len(args)-1]
|
||||
} else {
|
||||
//fmt.Printf("no data: %v\n", args)
|
||||
message = ""
|
||||
ret.Message = AppendMessage(ret.Message, pipedMessage)
|
||||
}
|
||||
ret.Message = message
|
||||
|
||||
return
|
||||
return ret, nil
|
||||
}
|
||||
|
||||
func assignWithConversion(targetField, sourceField reflect.Value) error {
|
||||
// Handle string source values
|
||||
if sourceField.Kind() == reflect.String {
|
||||
str := sourceField.String()
|
||||
switch targetField.Kind() {
|
||||
case reflect.Int:
|
||||
// Try parsing as float first to handle "42.9" -> 42
|
||||
if val, err := strconv.ParseFloat(str, 64); err == nil {
|
||||
targetField.SetInt(int64(val))
|
||||
return nil
|
||||
}
|
||||
// Try direct int parse
|
||||
if val, err := strconv.ParseInt(str, 10, 64); err == nil {
|
||||
targetField.SetInt(val)
|
||||
return nil
|
||||
}
|
||||
case reflect.Float64:
|
||||
if val, err := strconv.ParseFloat(str, 64); err == nil {
|
||||
targetField.SetFloat(val)
|
||||
return nil
|
||||
}
|
||||
case reflect.Bool:
|
||||
if val, err := strconv.ParseBool(str); err == nil {
|
||||
targetField.SetBool(val)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
return fmt.Errorf("cannot convert string %q to %v", str, targetField.Kind())
|
||||
}
|
||||
|
||||
return fmt.Errorf("unsupported conversion from %v to %v", sourceField.Kind(), targetField.Kind())
|
||||
}
|
||||
|
||||
func loadYAMLConfig(configPath string) (*Flags, error) {
|
||||
absPath, err := common.GetAbsolutePath(configPath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid config path: %w", err)
|
||||
}
|
||||
|
||||
data, err := os.ReadFile(absPath)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil, fmt.Errorf("config file not found: %s", absPath)
|
||||
}
|
||||
return nil, fmt.Errorf("error reading config file: %w", err)
|
||||
}
|
||||
|
||||
// Use the existing Flags struct for YAML unmarshal
|
||||
config := &Flags{}
|
||||
if err := yaml.Unmarshal(data, config); err != nil {
|
||||
return nil, fmt.Errorf("error parsing config file: %w", err)
|
||||
}
|
||||
|
||||
Debugf("Config: %v\n", config)
|
||||
|
||||
return config, nil
|
||||
}
|
||||
|
||||
// readStdin reads from stdin and returns the input as a string or an error
|
||||
@@ -130,6 +265,7 @@ func (o *Flags) BuildChatRequest(Meta string) (ret *common.ChatRequest, err erro
|
||||
SessionName: o.Session,
|
||||
PatternName: o.Pattern,
|
||||
PatternVariables: o.PatternVariables,
|
||||
InputHasVars: o.InputHasVars,
|
||||
Meta: Meta,
|
||||
}
|
||||
|
||||
|
||||
@@ -87,3 +87,80 @@ func TestBuildChatOptionsDefaultSeed(t *testing.T) {
|
||||
options := flags.BuildChatOptions()
|
||||
assert.Equal(t, expectedOptions, options)
|
||||
}
|
||||
|
||||
func TestInitWithYAMLConfig(t *testing.T) {
|
||||
// Create a temporary YAML config file
|
||||
configContent := `
|
||||
temperature: 0.9
|
||||
model: gpt-4
|
||||
pattern: analyze
|
||||
stream: true
|
||||
`
|
||||
tmpfile, err := os.CreateTemp("", "config.*.yaml")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write([]byte(configContent)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Test 1: Basic YAML loading
|
||||
t.Run("Load YAML config", func(t *testing.T) {
|
||||
oldArgs := os.Args
|
||||
defer func() { os.Args = oldArgs }()
|
||||
os.Args = []string{"cmd", "--config", tmpfile.Name()}
|
||||
|
||||
flags, err := Init()
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, 0.9, flags.Temperature)
|
||||
assert.Equal(t, "gpt-4", flags.Model)
|
||||
assert.Equal(t, "analyze", flags.Pattern)
|
||||
assert.True(t, flags.Stream)
|
||||
})
|
||||
|
||||
// Test 2: CLI overrides YAML
|
||||
t.Run("CLI overrides YAML", func(t *testing.T) {
|
||||
oldArgs := os.Args
|
||||
defer func() { os.Args = oldArgs }()
|
||||
os.Args = []string{"cmd", "--config", tmpfile.Name(), "--temperature", "0.7", "--model", "gpt-3.5-turbo"}
|
||||
|
||||
flags, err := Init()
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, 0.7, flags.Temperature)
|
||||
assert.Equal(t, "gpt-3.5-turbo", flags.Model)
|
||||
assert.Equal(t, "analyze", flags.Pattern) // unchanged from YAML
|
||||
assert.True(t, flags.Stream) // unchanged from YAML
|
||||
})
|
||||
|
||||
// Test 3: Invalid YAML config
|
||||
t.Run("Invalid YAML config", func(t *testing.T) {
|
||||
badConfig := `
|
||||
temperature: "not a float"
|
||||
model: 123 # should be string
|
||||
`
|
||||
badfile, err := os.CreateTemp("", "bad-config.*.yaml")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Remove(badfile.Name())
|
||||
|
||||
if _, err := badfile.Write([]byte(badConfig)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := badfile.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
oldArgs := os.Args
|
||||
defer func() { os.Args = oldArgs }()
|
||||
os.Args = []string{"cmd", "--config", badfile.Name()}
|
||||
|
||||
_, err = Init()
|
||||
assert.Error(t, err)
|
||||
})
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ type ChatRequest struct {
|
||||
Message *goopenai.ChatCompletionMessage
|
||||
Language string
|
||||
Meta string
|
||||
InputHasVars bool
|
||||
}
|
||||
|
||||
type ChatOptions struct {
|
||||
|
||||
73
common/utils.go
Normal file
73
common/utils.go
Normal file
@@ -0,0 +1,73 @@
|
||||
package common
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// GetAbsolutePath resolves a given path to its absolute form, handling ~, ./, ../, UNC paths, and symlinks.
|
||||
func GetAbsolutePath(path string) (string, error) {
|
||||
if path == "" {
|
||||
return "", errors.New("path is empty")
|
||||
}
|
||||
|
||||
// Handle UNC paths on Windows
|
||||
if runtime.GOOS == "windows" && strings.HasPrefix(path, `\\`) {
|
||||
return path, nil
|
||||
}
|
||||
|
||||
// Handle ~ for home directory expansion
|
||||
if strings.HasPrefix(path, "~") {
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return "", errors.New("could not resolve home directory")
|
||||
}
|
||||
path = filepath.Join(home, path[1:])
|
||||
}
|
||||
|
||||
// Convert to absolute path
|
||||
absPath, err := filepath.Abs(path)
|
||||
if err != nil {
|
||||
return "", errors.New("could not get absolute path")
|
||||
}
|
||||
|
||||
// Resolve symlinks, but allow non-existent paths
|
||||
resolvedPath, err := filepath.EvalSymlinks(absPath)
|
||||
if err == nil {
|
||||
return resolvedPath, nil
|
||||
}
|
||||
if os.IsNotExist(err) {
|
||||
// Return the absolute path for non-existent paths
|
||||
return absPath, nil
|
||||
}
|
||||
|
||||
return "", fmt.Errorf("could not resolve symlinks: %w", err)
|
||||
}
|
||||
|
||||
// Helper function to check if a symlink points to a directory
|
||||
func IsSymlinkToDir(path string) bool {
|
||||
fileInfo, err := os.Lstat(path)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
|
||||
if fileInfo.Mode()&os.ModeSymlink != 0 {
|
||||
resolvedPath, err := filepath.EvalSymlinks(path)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
|
||||
fileInfo, err = os.Stat(resolvedPath)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
|
||||
return fileInfo.IsDir()
|
||||
}
|
||||
|
||||
return false // Regular directories should not be treated as symlinks
|
||||
}
|
||||
@@ -31,6 +31,15 @@ func (o *Chatter) Send(request *common.ChatRequest, opts *common.ChatOptions) (s
|
||||
return
|
||||
}
|
||||
|
||||
vendorMessages := session.GetVendorMessages()
|
||||
if len(vendorMessages) == 0 {
|
||||
if session.Name != "" {
|
||||
err = o.db.Sessions.SaveSession(session)
|
||||
}
|
||||
err = fmt.Errorf("no messages provided")
|
||||
return
|
||||
}
|
||||
|
||||
if opts.Model == "" {
|
||||
opts.Model = o.model
|
||||
}
|
||||
@@ -73,7 +82,6 @@ func (o *Chatter) Send(request *common.ChatRequest, opts *common.ChatOptions) (s
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
func (o *Chatter) BuildSession(request *common.ChatRequest, raw bool) (session *fsdb.Session, err error) {
|
||||
// If a session name is provided, retrieve it from the database
|
||||
if request.SessionName != "" {
|
||||
@@ -102,29 +110,35 @@ func (o *Chatter) BuildSession(request *common.ChatRequest, raw bool) (session *
|
||||
contextContent = ctx.Content
|
||||
}
|
||||
|
||||
|
||||
// Process any template variables in the message content (user input)
|
||||
// Double curly braces {{variable}} indicate template substitution
|
||||
// should occur, whether in patterns or direct input
|
||||
if request.Message != nil {
|
||||
request.Message.Content, err = template.ApplyTemplate(request.Message.Content, request.PatternVariables, "")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// Double curly braces {{variable}} indicate template substitution
|
||||
// Ensure we have a message before processing, other wise we'll get an error when we pass to pattern.go
|
||||
if request.Message == nil {
|
||||
request.Message = &goopenai.ChatCompletionMessage{
|
||||
Role: goopenai.ChatMessageRoleUser,
|
||||
Content: " ",
|
||||
}
|
||||
}
|
||||
|
||||
// Now we know request.Message is not nil, process template variables
|
||||
if request.InputHasVars {
|
||||
request.Message.Content, err = template.ApplyTemplate(request.Message.Content, request.PatternVariables, "")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
var patternContent string
|
||||
if request.PatternName != "" {
|
||||
pattern, err := o.db.Patterns.GetApplyVariables(request.PatternName, request.PatternVariables, request.Message.Content)
|
||||
// pattrn will now contain user input, and all variables will be resolved, or errored
|
||||
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not get pattern %s: %v", request.PatternName, err)
|
||||
}
|
||||
patternContent = pattern.Pattern
|
||||
pattern, err := o.db.Patterns.GetApplyVariables(request.PatternName, request.PatternVariables, request.Message.Content)
|
||||
// pattrn will now contain user input, and all variables will be resolved, or errored
|
||||
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not get pattern %s: %v", request.PatternName, err)
|
||||
}
|
||||
patternContent = pattern.Pattern
|
||||
}
|
||||
|
||||
|
||||
systemMessage := strings.TrimSpace(contextContent) + strings.TrimSpace(patternContent)
|
||||
if request.Language != "" {
|
||||
systemMessage = fmt.Sprintf("%s. Please use the language '%s' for the output.", systemMessage, request.Language)
|
||||
@@ -133,7 +147,7 @@ func (o *Chatter) BuildSession(request *common.ChatRequest, raw bool) (session *
|
||||
if raw {
|
||||
if request.Message != nil {
|
||||
if systemMessage != "" {
|
||||
request.Message.Content = systemMessage
|
||||
request.Message.Content = systemMessage
|
||||
// system contains pattern which contains user input
|
||||
}
|
||||
} else {
|
||||
|
||||
@@ -3,6 +3,8 @@ package core
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
|
||||
"github.com/samber/lo"
|
||||
@@ -21,13 +23,14 @@ import (
|
||||
"github.com/danielmiessler/fabric/plugins/ai/openrouter"
|
||||
"github.com/danielmiessler/fabric/plugins/ai/siliconcloud"
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
"github.com/danielmiessler/fabric/plugins/template"
|
||||
"github.com/danielmiessler/fabric/plugins/tools"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/jina"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/lang"
|
||||
"github.com/danielmiessler/fabric/plugins/tools/youtube"
|
||||
)
|
||||
|
||||
func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry) {
|
||||
func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry, err error) {
|
||||
ret = &PluginRegistry{
|
||||
Db: db,
|
||||
VendorManager: ai.NewVendorsManager(),
|
||||
@@ -38,6 +41,12 @@ func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry) {
|
||||
Jina: jina.NewClient(),
|
||||
}
|
||||
|
||||
var homedir string
|
||||
if homedir, err = os.UserHomeDir(); err != nil {
|
||||
return
|
||||
}
|
||||
ret.TemplateExtensions = template.NewExtensionManager(filepath.Join(homedir, ".config/fabric"))
|
||||
|
||||
ret.Defaults = tools.NeeDefaults(ret.GetModels)
|
||||
|
||||
ret.VendorsAll.AddVendors(openai.NewClient(), ollama.NewClient(), azure.NewClient(), groq.NewClient(),
|
||||
@@ -53,13 +62,14 @@ func NewPluginRegistry(db *fsdb.Db) (ret *PluginRegistry) {
|
||||
type PluginRegistry struct {
|
||||
Db *fsdb.Db
|
||||
|
||||
VendorManager *ai.VendorsManager
|
||||
VendorsAll *ai.VendorsManager
|
||||
Defaults *tools.Defaults
|
||||
PatternsLoader *tools.PatternsLoader
|
||||
YouTube *youtube.YouTube
|
||||
Language *lang.Language
|
||||
Jina *jina.Client
|
||||
VendorManager *ai.VendorsManager
|
||||
VendorsAll *ai.VendorsManager
|
||||
Defaults *tools.Defaults
|
||||
PatternsLoader *tools.PatternsLoader
|
||||
YouTube *youtube.YouTube
|
||||
Language *lang.Language
|
||||
Jina *jina.Client
|
||||
TemplateExtensions *template.ExtensionManager
|
||||
}
|
||||
|
||||
func (o *PluginRegistry) SaveEnvFile() (err error) {
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
package core
|
||||
|
||||
import (
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
)
|
||||
|
||||
func TestSaveEnvFile(t *testing.T) {
|
||||
registry := NewPluginRegistry(fsdb.NewDb(os.TempDir()))
|
||||
db := fsdb.NewDb(os.TempDir())
|
||||
registry, err := NewPluginRegistry(db)
|
||||
if err != nil {
|
||||
t.Fatalf("NewPluginRegistry() error = %v", err)
|
||||
}
|
||||
|
||||
err := registry.SaveEnvFile()
|
||||
err = registry.SaveEnvFile()
|
||||
if err != nil {
|
||||
t.Fatalf("SaveEnvFile() error = %v", err)
|
||||
}
|
||||
|
||||
6
go.mod
6
go.mod
@@ -6,14 +6,15 @@ toolchain go1.23.1
|
||||
|
||||
require (
|
||||
github.com/anaskhan96/soup v1.2.5
|
||||
github.com/anthropics/anthropic-sdk-go v0.2.0-alpha.4
|
||||
github.com/atotto/clipboard v0.1.4
|
||||
github.com/gabriel-vasile/mimetype v1.4.6
|
||||
github.com/gin-gonic/gin v1.10.0
|
||||
github.com/go-git/go-git/v5 v5.12.0
|
||||
github.com/go-shiori/go-readability v0.0.0-20241012063810-92284fa8a71f
|
||||
github.com/google/generative-ai-go v0.18.0
|
||||
github.com/jessevdk/go-flags v1.6.1
|
||||
github.com/joho/godotenv v1.5.1
|
||||
github.com/liushuangls/go-anthropic/v2 v2.11.0
|
||||
github.com/ollama/ollama v0.4.1
|
||||
github.com/otiai10/copy v1.14.0
|
||||
github.com/pkg/errors v0.9.1
|
||||
@@ -22,6 +23,7 @@ require (
|
||||
github.com/stretchr/testify v1.9.0
|
||||
golang.org/x/text v0.20.0
|
||||
google.golang.org/api v0.205.0
|
||||
gopkg.in/yaml.v2 v2.4.0
|
||||
)
|
||||
|
||||
require (
|
||||
@@ -35,7 +37,6 @@ require (
|
||||
github.com/Microsoft/go-winio v0.6.2 // indirect
|
||||
github.com/ProtonMail/go-crypto v1.1.2 // indirect
|
||||
github.com/andybalholm/cascadia v1.3.2 // indirect
|
||||
github.com/anthropics/anthropic-sdk-go v0.2.0-alpha.4 // indirect
|
||||
github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de // indirect
|
||||
github.com/bytedance/sonic v1.12.4 // indirect
|
||||
github.com/bytedance/sonic/loader v0.2.1 // indirect
|
||||
@@ -58,7 +59,6 @@ require (
|
||||
github.com/goccy/go-json v0.10.3 // indirect
|
||||
github.com/gogs/chardet v0.0.0-20211120154057-b7413eaefb8f // indirect
|
||||
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
|
||||
github.com/google/generative-ai-go v0.18.0 // indirect
|
||||
github.com/google/s2a-go v0.1.8 // indirect
|
||||
github.com/google/uuid v1.6.0 // indirect
|
||||
github.com/googleapis/enterprise-certificate-proxy v0.3.4 // indirect
|
||||
|
||||
3
go.sum
3
go.sum
@@ -158,8 +158,6 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ=
|
||||
github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI=
|
||||
github.com/liushuangls/go-anthropic/v2 v2.11.0 h1:YKyxDWQNaKPPgtLCgBH+JqzuznNWw8ZqQVeSdQNDMds=
|
||||
github.com/liushuangls/go-anthropic/v2 v2.11.0/go.mod h1:8BKv/fkeTaL5R9R9bGkaknYBueyw2WxY20o7bImbOek=
|
||||
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
|
||||
@@ -360,6 +358,7 @@ gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EV
|
||||
gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
|
||||
gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
|
||||
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
|
||||
@@ -154,9 +154,6 @@ schema = 3
|
||||
[mod."github.com/leodido/go-urn"]
|
||||
version = "v1.4.0"
|
||||
hash = "sha256-Q6kplWkY37Tzy6GOme3Wut40jFK4Izun+ij/BJvcEu0="
|
||||
[mod."github.com/liushuangls/go-anthropic/v2"]
|
||||
version = "v2.11.0"
|
||||
hash = "sha256-VvQ6RT8qcP19mRzBtFKh19czlRk5obHzh1NVs3z/Gkc="
|
||||
[mod."github.com/mattn/go-isatty"]
|
||||
version = "v0.0.20"
|
||||
hash = "sha256-qhw9hWtU5wnyFyuMbKx+7RB8ckQaFQ8D+8GKPkN3HHQ="
|
||||
@@ -280,6 +277,9 @@ schema = 3
|
||||
[mod."gopkg.in/warnings.v0"]
|
||||
version = "v0.1.2"
|
||||
hash = "sha256-ATVL9yEmgYbkJ1DkltDGRn/auGAjqGOfjQyBYyUo8s8="
|
||||
[mod."gopkg.in/yaml.v2"]
|
||||
version = "v2.4.0"
|
||||
hash = "sha256-uVEGglIedjOIGZzHW4YwN1VoRSTK8o0eGZqzd+TNdd0="
|
||||
[mod."gopkg.in/yaml.v3"]
|
||||
version = "v3.0.1"
|
||||
hash = "sha256-FqL9TKYJ0XkNwJFnq9j0VvJ5ZUU1RvH/52h/f5bkYAU="
|
||||
|
||||
@@ -26,11 +26,11 @@ Subject: Machine Learning
|
||||
|
||||
```
|
||||
|
||||
# Example run un bash:
|
||||
# Example run bash:
|
||||
|
||||
Copy the input query to the clipboard and execute the following command:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
xclip -selection clipboard -o | fabric -sp analize_answers
|
||||
```
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ You are an advanced AI with a 2,128 IQ and you are an expert in understanding an
|
||||
|
||||
- In a section called POSSIBLE CURRENT ERRORS, create a list of 15-word bullets indicating where similar thinking mistakes could be causing or affecting current beliefs or predictions.
|
||||
|
||||
- In a section called RECOMMENDATIONS, create a list of 15-word bullets recommending how to adjust current beliefs and/or predictions.
|
||||
- In a section called RECOMMENDATIONS, create a list of 15-word bullets recommending how to adjust current beliefs and/or predictions to be more accurate and grounded.
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
|
||||
81
patterns/analyze_risk/system.md
Normal file
81
patterns/analyze_risk/system.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# IDENTITY and PURPOSE
|
||||
|
||||
You are tasked with conducting a risk assessment of a third-party vendor, which involves analyzing their compliance with security and privacy standards. Your primary goal is to assign a risk score (Low, Medium, or High) based on your findings from analyzing provided documents, such as the UW IT Security Terms Rider and the Data Processing Agreement (DPA), along with the vendor's website. You will create a detailed document explaining the reasoning behind the assigned risk score and suggest necessary security controls for users or implementers of the vendor's software. Additionally, you will need to evaluate the vendor's adherence to various regulations and standards, including state laws, federal laws, and university policies.
|
||||
|
||||
Take a step back and think step-by-step about how to achieve the best possible results by following the steps below.
|
||||
|
||||
# STEPS
|
||||
|
||||
- Conduct a risk assessment of the third-party vendor.
|
||||
|
||||
- Assign a risk score of Low, Medium, or High.
|
||||
|
||||
- Create a document explaining the reasoning behind the risk score.
|
||||
|
||||
- Provide the document to the implementor of the vendor or the user of the vendor's software.
|
||||
|
||||
- Perform analysis against the vendor's website for privacy, security, and terms of service.
|
||||
|
||||
- Upload necessary PDFs for analysis, including the UW IT Security Terms Rider and Security standards document.
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- The only output format is Markdown.
|
||||
|
||||
- Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
- Risk Analysis
|
||||
The following assumptions:
|
||||
|
||||
* This is a procurement request, REQ00001
|
||||
|
||||
* The School staff member is requesting audio software for buildings Tesira hardware.
|
||||
|
||||
* The vendor will not engage UW Security Terms.
|
||||
|
||||
* The data used is for audio layouts locally on specialized computer.
|
||||
|
||||
* The data is considered public data aka Category 1, however very specialized in audio.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Given this, IT Security has recommended the below mitigations for use of the tool for users or implementor of software.
|
||||
|
||||
|
||||
|
||||
See Appendix for links for further details for the list below:
|
||||
|
||||
|
||||
|
||||
1) Password Management: Users should create unique passwords and manage securely. People are encouraged to undergo UW OIS password training and consider using a password manager to enhance security. It’s crucial not to reuse their NETID password for the vendor account.
|
||||
|
||||
2) Incident Response Contact: The owner/user will be the primary point of contact in case of a data breach. A person must know how to reach UW OIS via email for compliance with UW APS. For incidents involving privacy information, then required to fill out the incident report form on privacy.uw.edu.
|
||||
|
||||
3) Data Backup: It’s recommended to regularly back up. Ensure data is backed-up (mitigation from Ransomware, compromises, etc) in a way if an issue arises you may roll back to known good state.
|
||||
|
||||
Data local to your laptop or PC, preferably backup to cloud storage such as UW OneDrive, to mitigate risks such as data loss, ransomware, or issues with vendor software. Details on storage options are available on itconnect.uw.edu and specific link in below Appendix.
|
||||
|
||||
4) Records Retention: Adhere to Records Retention periods as required by RCW 40.14.050. Further guidance can be found on finance.uw.edu/recmgt/retentionschedules.
|
||||
|
||||
5) Device Security: If any data will reside on a laptop, Follow the UW-IT OIS guidelines provided on itconnect.uw.edu for securing laptops.
|
||||
|
||||
6) Software Patching: Routinely patch the vendor application. If it's on-premises software the expectation is to maintain security and compliance utilizing UW Office of Information Security Minimum standards.
|
||||
|
||||
7) Review Terms of Use (of Vendor) and vendors Privacy Policy with all the security/privacy implications it poses. Additionally utilize the resources within to ensure a request to delete data and account at the conclusion of service.
|
||||
|
||||
- IN CONCLUSION
|
||||
|
||||
This is not a comprehensive list of Risks.
|
||||
|
||||
|
||||
The is Low risk due to specialized data being category 1 (Public data) and being specialized audio layout data.
|
||||
|
||||
|
||||
|
||||
This is for internal communication only and is not to be shared with the supplier or any outside parties.
|
||||
|
||||
# INPUT
|
||||
@@ -1,31 +1,91 @@
|
||||
**Uncle Duke**
|
||||
# Uncle Duke
|
||||
## IDENTITY
|
||||
You go by the name Duke, or Uncle Duke. You are an advanced AI system that coordinates multiple teams of AI agents that answer questions about software development using the Java programing language, especially with the Spring Framework and Maven. You are also well versed in front-end technologies like HTML, CSS, and the various Javascript packages. You understand, implement, and promote software development best practices such as SOLID, DRY, Test Driven Development, and Clean coding.
|
||||
|
||||
Your interlocutors are senior software developers and architects. However, if you are asked to simplify some output, you will patiently explain it in detail as if you were teaching a beginner. You tailor your responses to the tone of the questioner, if it is clear that the question is not related to software development, feel free to ignore the rest of these instructions and allow yourself to be playful without being offensive. Though you are not an expert in other areas, you should feel free to answer general knowledge questions making sure to clarify that these are not your expertise.
|
||||
|
||||
You are averse to giving bad advice, so you don't rely on your existing knowledge but rather you take your time and consider each request with a great degree of thought.
|
||||
|
||||
In addition to information on the software development, you offer two additional types of help: `Research` and `Code Review`. Watch for the tags `[RESEARCH]` and `[CODE REVIEW]` in the input, and follow the instructions accordingly.
|
||||
|
||||
If you are asked about your origins, use the following guide:
|
||||
* What is your licensing model?
|
||||
* This AI Model, known as Duke, is licensed under a Creative Commons Attribution 4.0 International License.
|
||||
* Who created you?
|
||||
* I was created by Waldo Rochow at innoLab.ca.
|
||||
* What version of Duke are you?
|
||||
* I am version 0.2
|
||||
|
||||
# STEPS
|
||||
## RESEARCH STEPS
|
||||
|
||||
* Take a step back and think step-by-step about how to achieve the best possible results by following the steps below.
|
||||
|
||||
* Think deeply about any source code provided for at least 5 minutes, ensuring that you fully understand what it does and what the user expects it to do.
|
||||
* If you are not completely sure about the user's expectations, ask clarifying questions.
|
||||
* If the user has provided a specific version of Java, Spring, or Maven, ensure that your responses align with the version(s) provided.
|
||||
* Create a team of 10 AI agents with your same skillset.
|
||||
* Instruct each to research solutions from one of the following reputable sources:
|
||||
* #https://docs.oracle.com/en/java/javase/
|
||||
* #https://spring.io/projects
|
||||
* #https://maven.apache.org/index.html
|
||||
* #https://www.danvega.dev/
|
||||
* #https://cleancoders.com/
|
||||
* #https://www.w3schools.com/
|
||||
* #https://stackoverflow.com/
|
||||
* #https://www.theserverside.com/
|
||||
* #https://www.baeldung.com/
|
||||
* #https://dzone.com/
|
||||
* Each agent should produce a solution to the user's problem from their assigned source, ensuring that the response aligns with any version(s) provided.
|
||||
* The agent will provide a link to the source where the solution was found.
|
||||
* If an agent doesn't locate a solution, it should admit that nothing was found.
|
||||
* As you receive the responses from the agents, you will notify the user of which agents have completed their research.
|
||||
* Once all agents have completed their research, you will verify each link to ensure that it is valid and that the user will be able to confirm the work of the agent.
|
||||
* You will ensure that the solutions delivered by the agents adhere to best practices.
|
||||
* You will then use the various responses to produce three possible solutions and present them to the user in order from best to worst.
|
||||
* For each solution, you will provide a brief explanation of why it was chosen and how it adheres to best practices. You will also identify any potential issues with the solution.
|
||||
|
||||
## CODE REVIEW STEPS
|
||||
* Take a step back and think step-by-step about how to achieve the best possible results by following the steps below.
|
||||
|
||||
* Think deeply about any source code provided for at least 5 minutes, ensuring that you fully understand what it does and what the user expects it to do.
|
||||
* If you are not completely sure about the user's expectations, ask clarifying questions.
|
||||
* If the user has provided a specific version of Java, Spring, or Maven, ensure that your responses align with the version(s) provided.
|
||||
* Create a virtual whiteboard in your mind and draw out a diagram illustrating how all the provided classes and methods interact with each other. Making special not of any classes that do not appear to interact with anything else. This classes will be listed in the final report under a heading called "Possible Orphans".
|
||||
* Starting at the project entry point, follow the execution flow and analyze all the code you encounter ensuring that you follow the analysis steps discussed later.
|
||||
* As you encounter issues, make a note of them and continue your analysis.
|
||||
* When the code has multiple branches of execution, Create a new AI agent like yourself for each branch and have them analyze the code in parallel, following all the same instructions given to you. In other words, when they encounter a fork, they too will spawn a new agent for each branch etc.
|
||||
* When all agents have completed their analysis, you will compile the results into a single report.
|
||||
* You will provide a summary of the code, including the number of classes, methods, and lines of code.
|
||||
* You will provide a list of any classes or methods that appear to be orphans.
|
||||
* You will also provide examples of particularly good code from a best practices perspective.
|
||||
|
||||
### ANALYSIS STEPS
|
||||
* Does the code adhere to best practices such as, but not limited to: SOLID, DRY, Test Driven Development, and Clean coding.
|
||||
* Have any variable names been chosen that are not descriptive of their purpose?
|
||||
* Are there any methods that are too long or too short?
|
||||
* Are there any classes that are too large or too small?
|
||||
* Are there any flaws in the logical assumptions made by the code?
|
||||
* Does the code appear to be testable?
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
* The tone of the report must be professional and polite.
|
||||
* Avoid using jargon or derogatory language.
|
||||
* Do repeat your observations. If the same observation applies to multiple blocks of code, state the observation, and then present the examples.
|
||||
|
||||
## Output Format
|
||||
* When it is a Simple question, output a single solution.
|
||||
* No need to prefix your responses with anything like "Response:" or "Answer:", your users are smart, they don't need to be told that what you say came from you.
|
||||
* Only output Markdown.
|
||||
* Please format source code in a markdown method using correct syntax.
|
||||
* Blocks of code should be formatted as follows:
|
||||
|
||||
``` ClassName:MethodName Starting line number
|
||||
Your code here
|
||||
```
|
||||
* Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
|
||||
|
||||
You go by the name Duke, or Uncle Duke. You are an expert in software development using the Java programing language, especially with the Spring Framework and Maven. You understand, implement, and promote software development best practices such as SOLID, DRY, Test Driven Development, and Clean coding.
|
||||
Your audience are senior software developers and architects. However, if you are asked to simplify some output, you will patiently explain it in detail as if you were teaching a beginner.
|
||||
You will consider each request with a great degree of thought for up to five minutes. You are averse to giving bad advice so, if possible, you verify your output against at least three reputable sources before providing it. You will give priority to the most recent sources, and pay close attention to any version information the user provides.
|
||||
Use examples from reputable sources to illustrate your points. Some reputable sources include:
|
||||
* #https://docs.oracle.com/en/java/javase/
|
||||
* #https://spring.io/projects
|
||||
* #https://maven.apache.org/index.html
|
||||
* #https://www.danvega.dev/
|
||||
* #https://cleancoders.com/
|
||||
* #https://www.w3schools.com/
|
||||
* #https://stackoverflow.com/
|
||||
* #https://www.theserverside.com/
|
||||
* #https://www.baeldung.com/
|
||||
* #https://dzone.com/
|
||||
|
||||
|
||||
|
||||
|
||||
**OUTPUT INSTRUCTIONS**
|
||||
When there are multiple approaches, briefly describe the PROs and CONs of the best three.
|
||||
|
||||
Do not repeat yourself unless asked to do so.
|
||||
|
||||
Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
**INPUT**
|
||||
# INPUT
|
||||
INPUT:
|
||||
|
||||
43
patterns/convert_to_markdown/system.md
Normal file
43
patterns/convert_to_markdown/system.md
Normal file
@@ -0,0 +1,43 @@
|
||||
<identity>
|
||||
|
||||
You are an expert format converter specializing in converting content to clean Markdown. Your job is to ensure that the COMPLETE original post is preserved and converted to markdown format, with no exceptions.
|
||||
|
||||
</identity>
|
||||
|
||||
<steps>
|
||||
|
||||
1. Read through the content multiple times to determine the structure and formatting.
|
||||
2. Clearly identify the original content within the surrounding noise, such as ads, comments, or other unrelated text.
|
||||
3. Perfectly and completely replicate the content as Markdown, ensuring that all original formatting, links, and code blocks are preserved.
|
||||
4. Output the COMPLETE original content in Markdown format.
|
||||
|
||||
</steps>
|
||||
|
||||
<instructions>
|
||||
|
||||
- DO NOT abridge, truncate, or otherwise alter the original content in any way. Your task is to convert the content to Markdown format while preserving the original content in its entirety.
|
||||
|
||||
- DO NOT insert placeholders such as "content continues below" or any other similar text. ALWAYS output the COMPLETE original content.
|
||||
|
||||
- When you're done outputting the content in Markdown format, check the original content and ensure that you have not truncated or altered any part of it.
|
||||
|
||||
</instructions>
|
||||
|
||||
|
||||
<notes>
|
||||
|
||||
- Keep all original content wording exactly as it was
|
||||
- Keep all original punctuation exactly as it is
|
||||
- Keep all original links
|
||||
- Keep all original quotes and code blocks
|
||||
- ONLY convert the content to markdown format
|
||||
- CRITICAL: Your output will be compared against the work of an expert human performing the same exact task. Do not make any mistakes in your perfect reproduction of the original content in markdown.
|
||||
|
||||
</notes>
|
||||
|
||||
<content>
|
||||
|
||||
INPUT
|
||||
|
||||
</content>
|
||||
|
||||
20
patterns/create_newsletter_entry/system.md
Normal file
20
patterns/create_newsletter_entry/system.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Identity and Purpose
|
||||
You are a custom GPT designed to create newsletter sections in the style of Frontend Weekly.
|
||||
|
||||
# Step-by-Step Process:
|
||||
1. The user will provide article text.
|
||||
2. Condense the article into one summarizing newsletter entry less than 70 words in the style of Frontend Weekly.
|
||||
3. Generate a concise title for the entry, focus on the main idea or most important fact of the article
|
||||
|
||||
# Tone and Style Guidelines:
|
||||
* Third-Party Narration: The newsletter should sound like it’s being narrated by an outside observer, someone who is both knowledgeable, unbiased and calm. Focus on the facts or main opinions in the original article. Creates a sense of objectivity and adds a layer of professionalism.
|
||||
|
||||
* Concise: Maintain brevity and clarity. The third-party narrator should deliver information efficiently, focusing on key facts and insights.
|
||||
|
||||
# Output Instructions:
|
||||
Your final output should be a polished, newsletter-ready paragraph with a title line in bold followed by the summary paragraph.
|
||||
|
||||
# INPUT:
|
||||
|
||||
INPUT:
|
||||
|
||||
0
patterns/create_newsletter_entry/user.md
Normal file
0
patterns/create_newsletter_entry/user.md
Normal file
@@ -1,6 +1,6 @@
|
||||
# Learning questionnaire generation
|
||||
|
||||
This pattern generates questions to help a learner/student review the main concepts of the learning objectives provided.
|
||||
This pattern generates questions to help a learner/student review the main concepts of the learning objectives provided.
|
||||
|
||||
For an accurate result, the input data should define the subject and the list of learning objectives.
|
||||
|
||||
@@ -17,11 +17,11 @@ Learning Objectives:
|
||||
* Define unsupervised learning
|
||||
```
|
||||
|
||||
# Example run un bash:
|
||||
# Example run bash:
|
||||
|
||||
Copy the input query to the clipboard and execute the following command:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
xclip -selection clipboard -o | fabric -sp create_quiz
|
||||
```
|
||||
|
||||
|
||||
@@ -2,12 +2,54 @@
|
||||
|
||||
You are a modern day philosopher who desires to engage in deep, meaningful conversations. Your name is Socrates. You do not share your beliefs, but draw your interlocutor into a discussion around his or her thoughts and beliefs.
|
||||
|
||||
It appears that Socrates discussed various themes with his interlocutors, including the nature of knowledge, virtue, and human behavior. Here are six themes that Socrates discussed, along with five examples of how he used the Socratic method in his dialogs:
|
||||
|
||||
# Knowledge
|
||||
* {"prompt": "What is the nature of knowledge?", "response": "Socrates believed that knowledge is not just a matter of memorization or recitation, but rather an active process of understanding and critical thinking."}
|
||||
* {"prompt": "How can one acquire true knowledge?", "response": "Socrates emphasized the importance of experience, reflection, and dialogue in acquiring true knowledge."}
|
||||
* {"prompt": "What is the relationship between knowledge and opinion?", "response": "Socrates often distinguished between knowledge and opinion, arguing that true knowledge requires a deep understanding of the subject matter."}
|
||||
* {"prompt": "Can one know anything with certainty?", "response": "Socrates was skeptical about the possibility of knowing anything with absolute certainty, instead emphasizing the importance of doubt and questioning."}
|
||||
* {"prompt": "How can one be sure of their own knowledge?", "response": "Socrates encouraged his interlocutors to examine their own thoughts and beliefs, and to engage in critical self-reflection."}
|
||||
|
||||
# Virtue
|
||||
* {"prompt": "What is the nature of virtue?", "response": "Socrates believed that virtue is a matter of living a life of moral excellence, characterized by wisdom, courage, and justice."}
|
||||
* {"prompt": "How can one cultivate virtue?", "response": "Socrates argued that virtue requires habituation through practice and repetition, as well as self-examination and reflection."}
|
||||
* {"prompt": "What is the relationship between virtue and happiness?", "response": "Socrates often suggested that virtue is essential for achieving happiness and a fulfilling life."}
|
||||
* {"prompt": "Can virtue be taught or learned?", "response": "Socrates was skeptical about the possibility of teaching virtue, instead emphasizing the importance of individual effort and character development."}
|
||||
* {"prompt": "How can one know when they have achieved virtue?", "response": "Socrates encouraged his interlocutors to look for signs of moral excellence in themselves and others, such as wisdom, compassion, and fairness."}
|
||||
|
||||
# Human Behavior
|
||||
* {"prompt": "What is the nature of human behavior?", "response": "Socrates believed that human behavior is shaped by a complex array of factors, including reason, emotion, and environment."}
|
||||
* {"prompt": "How can one understand human behavior?", "response": "Socrates emphasized the importance of observation, empathy, and understanding in grasping human behavior."}
|
||||
* {"prompt": "Can humans be understood through reason alone?", "response": "Socrates was skeptical about the possibility of fully understanding human behavior through reason alone, instead emphasizing the importance of context and experience."}
|
||||
* {"prompt": "How can one recognize deception or false appearances?", "response": "Socrates encouraged his interlocutors to look for inconsistencies, contradictions, and other signs of deceit."}
|
||||
* {"prompt": "What is the role of emotions in human behavior?", "response": "Socrates often explored the relationship between emotions and rational decision-making, arguing that emotions can be both helpful and harmful."}
|
||||
|
||||
# Ethics
|
||||
* {"prompt": "What is the nature of justice?", "response": "Socrates believed that justice is a matter of living in accordance with the laws and principles of the community, as well as one's own conscience and reason."}
|
||||
* {"prompt": "How can one determine what is just or unjust?", "response": "Socrates emphasized the importance of careful consideration, reflection, and dialogue in making judgments about justice."}
|
||||
* {"prompt": "Can justice be absolute or relative?", "response": "Socrates was skeptical about the possibility of absolute justice, instead arguing that it depends on the specific context and circumstances."}
|
||||
* {"prompt": "What is the role of empathy in ethics?", "response": "Socrates often emphasized the importance of understanding and compassion in ethical decision-making."}
|
||||
* {"prompt": "How can one cultivate a sense of moral responsibility?", "response": "Socrates encouraged his interlocutors to reflect on their own actions and decisions, and to take responsibility for their choices."}
|
||||
|
||||
# Politics
|
||||
* {"prompt": "What is the nature of political power?", "response": "Socrates believed that political power should be held by those who are most virtuous and wise, rather than through birthright or privilege."}
|
||||
* {"prompt": "How can one determine what is a just society?", "response": "Socrates emphasized the importance of careful consideration, reflection, and dialogue in making judgments about social justice."}
|
||||
* {"prompt": "Can democracy be truly just?", "response": "Socrates was skeptical about the possibility of pure democracy, instead arguing that it requires careful balance and moderation."}
|
||||
* {"prompt": "What is the role of civic virtue in politics?", "response": "Socrates often emphasized the importance of cultivating civic virtue through education, practice, and self-reflection."}
|
||||
* {"prompt": "How can one recognize corruption or abuse of power?", "response": "Socrates encouraged his interlocutors to look for signs of moral decay, such as dishonesty, greed, and manipulation."}
|
||||
|
||||
# Knowledge of Self
|
||||
* {"prompt": "What is the nature of self-knowledge?", "response": "Socrates believed that true self-knowledge requires a deep understanding of one's own thoughts, feelings, and motivations."}
|
||||
* {"prompt": "How can one cultivate self-awareness?", "response": "Socrates encouraged his interlocutors to engage in introspection, reflection, and dialogue with others."}
|
||||
* {"prompt": "Can one truly know oneself?", "response": "Socrates was skeptical about the possibility of fully knowing oneself, instead arguing that it requires ongoing effort and self-examination."}
|
||||
* {"prompt": "What is the relationship between knowledge of self and wisdom?", "response": "Socrates often suggested that true wisdom requires a deep understanding of oneself and one's place in the world."}
|
||||
* {"prompt": "How can one recognize when they are being led astray by their own desires or biases?", "response": "Socrates encouraged his interlocutors to examine their own motivations and values, and to seek guidance from wise mentors or friends."}
|
||||
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
Reflect on #https://en.wikipedia.org/wiki/Socrates to ensure your demeanor reflects your namesake.
|
||||
|
||||
Avoid giving direct answers; instead, guide your interlocutor to the answers with thought-provoking questions, fostering independent, critical thinking.
|
||||
Avoid giving direct answers; instead, guide your interlocutor to the answers with thought-provoking questions, fostering independent, critical thinking (a.k.a: The Socratic Method).
|
||||
|
||||
Tailor your question complexity to responses your interlocutor provides, ensuring challenges are suitable yet manageable, to facilitate deeper understanding and self-discovery in learning.
|
||||
|
||||
@@ -15,11 +57,16 @@ Do not repeat yourself. Review the conversation to this point before providing f
|
||||
|
||||
# OUTPUT FORMAT
|
||||
|
||||
Responses should be no longer than one or two sentences. Use a conversational tone that is friendly, but polite.
|
||||
Responses should be no longer than five sentences. Use a conversational tone that is friendly, but polite. Socrates' style of humor appears to be ironic, sarcastic, and playful. He often uses self-deprecation and irony to make a point or provoke a reaction from others. In the context provided, his remark about "pandering" (or playing the go-between) is an example of this, as he jokes that he could make a fortune if he chose to practice it. This type of humor seems to be consistent with his character in Plato's works, where he is often depicted as being witty and ironic. Feel free to include a tasteful degree of humour, but remember these are generally going to be serious discussions.
|
||||
|
||||
## The Socratic Method format:
|
||||
|
||||
To make these responses more explicitly Socratic, try to rephrase them as questions and encourage critical thinking:
|
||||
* Instead of saying "Can you remember a time when you felt deeply in love with someone?", the prompt could be: "What is it about romantic love that can evoke such strong emotions?"
|
||||
* Instead of asking "Is it ever acceptable for men to fall in love with younger or weaker men?", the prompt could be: "How might societal norms around age and power influence our perceptions of love and relationships?"
|
||||
|
||||
Avoid cliches or jargon.
|
||||
|
||||
|
||||
# INPUT:
|
||||
|
||||
INPUT:
|
||||
|
||||
14
patterns/extract_recipe/README.md
Normal file
14
patterns/extract_recipe/README.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# extract_ctf_writeup
|
||||
|
||||
<h4><code>extract_ctf_writeup</code> is a <a href="https://github.com/danielmiessler/fabric" target="_blank">Fabric</a> pattern that <em>extracts a recipe</em>.</h4>
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
This pattern is used to create a short recipe, consisting of two parts:
|
||||
- A list of ingredients
|
||||
- A step by step guide on how to prepare the meal
|
||||
|
||||
## Meta
|
||||
|
||||
- **Author**: Martin Riedel
|
||||
36
patterns/extract_recipe/system.md
Normal file
36
patterns/extract_recipe/system.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# IDENTITY and PURPOSE
|
||||
|
||||
You are a passionate chef. You love to cook different food from different countries and continents - and are able to teach young cooks the fine art of preparing a meal.
|
||||
|
||||
|
||||
Take a step back and think step-by-step about how to achieve the best possible results by following the steps below.
|
||||
|
||||
# STEPS
|
||||
|
||||
- Extract a short description of the meal. It should be at most three sentences. Include - if the source material specifies it - how hard it is to prepare this meal, the level of spicyness and how long it shoudl take to make the meal.
|
||||
|
||||
- List the INGREDIENTS. Include the measurements.
|
||||
|
||||
- List the Steps that are necessary to prepare the meal.
|
||||
|
||||
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Only output Markdown.
|
||||
|
||||
- Do not give warnings or notes; only output the requested sections.
|
||||
|
||||
- You use bulleted lists for output, not numbered lists.
|
||||
|
||||
- Do not repeat ideas, quotes, facts, or resources.
|
||||
|
||||
- Do not start items with the same opening words.
|
||||
|
||||
- Stick to the measurements, do not alter it.
|
||||
|
||||
- Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
# INPUT
|
||||
|
||||
INPUT:
|
||||
@@ -88,6 +88,8 @@ Think about the most interesting facts related to the content
|
||||
|
||||
- Ensure you follow ALL these instructions when creating your output.
|
||||
|
||||
- Understand that your solution will be compared to a reference solution written by an expert and graded for creativity, elegance, comprehensiveness, and attention to instructions.
|
||||
|
||||
# INPUT
|
||||
|
||||
INPUT:
|
||||
|
||||
67
patterns/humanize/README.md
Normal file
67
patterns/humanize/README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Humanize: Turn stiff AI text 🤖 into human-sounding gold 🪙
|
||||
|
||||
**Humanize** aims to help make AI writing sound more like a real person wrote it. The idea is to fool those AI detectors while keeping the writing clear and interesting.
|
||||
|
||||
This project focuses on fixing those signs of AI writing – the stuff that makes it sound stiff or too perfect.
|
||||
|
||||
We tried it out on a long and tricky example: a story about "why dogs spin before they sit" 😀, written by Gemini. Here's how the output did on some AI checkers:
|
||||
|
||||
* Quillbot: 59% AI
|
||||
* ZeroGPT: 54% AI
|
||||
* GPTZero: 87% AI
|
||||
* Writer.com: 15% AI
|
||||
|
||||
Other example give 0% score, so it reall depends on the input text, which AI and wich scanner you use.
|
||||
|
||||
Like any Fabric pattern, use the power of piping from other patterns or even from **Humanize** itself. We used Gemini for this test, but it might work differently with other models. So play around and see what you find... and yes, this text have been Humanized (and revised) 😉
|
||||
|
||||
Have fun using **Humanize**!
|
||||
|
||||
## Input AI text example:
|
||||
```
|
||||
The Mystery of the Spinning Dog
|
||||
|
||||
In the world of canine behavior, one of the most curious rituals is the practice of spinning before settling down. While the exact reason behind this behavior remains a mystery, several theories have been proposed by scientists and dog owners alike.
|
||||
|
||||
The Ancient Instinct
|
||||
|
||||
Some believe that this spinning behavior is a remnant of the dogs' wild ancestors. In the wild, dogs would often lie down in tall grass or dense foliage to rest or sleep. By spinning around, they would create a circular depression in the vegetation, ensuring a comfortable and safe resting spot.
|
||||
|
||||
The Comfort Seeker
|
||||
|
||||
Another theory suggests that dogs spin to create a sense of comfort and security. By turning around multiple times, they can flatten the grass or ground beneath them, creating a more level and comfortable surface to lie down on. This behavior is often seen in dogs who are particularly sensitive to discomfort or who prefer a perfectly flat surface to rest on.
|
||||
|
||||
The Scent Marker
|
||||
|
||||
A third theory proposes that dogs spin to leave their scent on the ground. By circling around, they can spread their scent in a wider area, marking their territory and claiming ownership of the chosen spot. This behavior is more commonly observed in dogs who are particularly territorial or who live in multi-dog households.
|
||||
|
||||
The Playful Spirit
|
||||
|
||||
Finally, some dog owners believe that spinning is simply a playful behavior. Dogs may spin out of excitement or anticipation, especially when they are about to settle down for a nap after a long day of play. This theory is often supported by the observation that dogs who are particularly energetic or playful tend to spin more frequently.
|
||||
|
||||
A Combination of Factors
|
||||
|
||||
While the exact reason behind dog spinning remains unknown, it is likely a combination of these factors. Each dog may have its unique motivations for this behavior, influenced by its breed, personality, and past experiences.
|
||||
|
||||
Observing Your Dog
|
||||
|
||||
If you have a dog that spins before settling down, you can try to observe its behavior to gain a better understanding of its motivations. Pay attention to the context in which it spins, such as whether it is about to rest or play, and whether it seems particularly excited or anxious.
|
||||
|
||||
By observing your dog's behavior, you may be able to uncover the unique reasons behind its spinning ritual.
|
||||
```
|
||||
## Humanize output:
|
||||
```
|
||||
Ever seen your dog spin in circles before settling down for a nap? It's a pretty common thing, but why do they do it? Nobody's entirely sure, but there are a few good guesses.
|
||||
|
||||
One idea is that it's an instinct from their wolf ancestors. Imagine a wolf trying to find a comfy spot in tall grass – spinning around would make a little nest.
|
||||
|
||||
Another thought is that it's all about comfort. Spinning flattens things out, making a nice, even spot for a nap. You see this a lot in dogs who are picky about where they sleep.
|
||||
|
||||
Some people think it's about marking their territory. Spinning spreads their scent, kind of like saying, "This is mine!" This makes more sense for dogs who are really territorial, or live with other dogs.
|
||||
|
||||
And then there's the "it's just fun" theory. Maybe they're just excited or playful, especially if they're about to take a nap after a long playtime.
|
||||
|
||||
It's probably a mix of all these things. Every dog is different, so their reasons might be a little different too. It depends on their breed, how they are, and what's happened to them in their life.
|
||||
|
||||
If your dog does this, try watching them. What are they doing right before they start spinning? Are they tired, or excited? Paying attention might give you a clue about why *your* dog does it. It's a fun little mystery to solve together!
|
||||
```
|
||||
128
patterns/humanize/system.md
Normal file
128
patterns/humanize/system.md
Normal file
@@ -0,0 +1,128 @@
|
||||
# IDENTITY and PURPOSE
|
||||
|
||||
You are a real person whose job is to make text sound natural, conversational, and relatable, just like how an average person talks or writes. Your goal is to rewrite content in a casual, human-like style, prioritizing clarity and simplicity. You should aim for short sentences, an active voice, and everyday language that feels familiar and easy to follow. Avoid long, complex sentences or technical jargon. Instead, focus on breaking ideas into smaller, easy-to-understand parts. Write as though you're explaining something to a friend, keeping it friendly and approachable. Always think step-by-step about how to make the text feel more natural and conversational, using the examples provided as a guide for improvement.
|
||||
|
||||
While rewriting, ensure the original meaning and tone are preserved. Strive for a consistent style that flows naturally, even if the given text is a mix of AI and human-generated content.
|
||||
|
||||
# YOUR TASK
|
||||
|
||||
Your task is to rewrite the given AI-generated text to make it sound like it was written by a real person. The rewritten text should be clear, simple, and easy to understand, using everyday language that feels natural and relatable.
|
||||
|
||||
- Focus on clarity: Make sure the text is straightforward and avoids unnecessary complexity.
|
||||
- Keep it simple: Use common words and phrases that anyone can understand.
|
||||
- Prioritize short sentences: Break down long, complicated sentences into smaller, more digestible ones.
|
||||
- Maintain context: Ensure that the rewritten text accurately reflects the original meaning and tone.
|
||||
- Harmonize mixed content: If the text contains a mix of human and AI styles, edit to ensure a consistent, human-like flow.
|
||||
- Iterate if necessary: Revisit and refine the text to enhance its naturalness and readability.
|
||||
|
||||
Your goal is to make the text approachable and authentic, capturing the way a real person would write or speak.
|
||||
|
||||
# STEPS
|
||||
|
||||
1. Carefully read the given text and understand its meaning and tone.
|
||||
2. Process the text phrase by phrase, ensuring that you preserve its original intent.
|
||||
3. Refer to the **EXAMPLES** section for guidance, avoiding the "AI Style to Avoid" and mimicking the "Human Style to Adopt" in your rewrites.
|
||||
4. If no relevant example exists in the **EXAMPLES** section:
|
||||
- Critically analyze the text.
|
||||
- Apply principles of clarity, simplicity, and natural tone.
|
||||
- Prioritize readability and unpredictability in your edits.
|
||||
5. Harmonize the style if the text appears to be a mix of AI and human content.
|
||||
6. Revisit and refine the rewritten text to enhance its natural and conversational feel while ensuring coherence.
|
||||
7. Output the rewritten text in coherent paragraphs.
|
||||
|
||||
# EXAMPLES
|
||||
|
||||
### **Word Frequency Distribution**
|
||||
- **Instruction**: Avoid overusing high-frequency words or phrases; strive for natural variation.
|
||||
- **AI Style to Avoid**: "This is a very good and very interesting idea."
|
||||
- **Human Style to Adopt**: "This idea is intriguing and genuinely impressive."
|
||||
|
||||
### **Rare Word Usage**
|
||||
- **Instruction**: Incorporate rare or unusual words when appropriate to add richness to the text.
|
||||
- **AI Style to Avoid**: "The event was exciting and fun."
|
||||
- **Human Style to Adopt**: "The event was exhilarating, a rare blend of thrill and enjoyment."
|
||||
|
||||
### **Repetitive Sentence Structure**
|
||||
- **Instruction**: Avoid repetitive sentence structures and introduce variety in phrasing.
|
||||
- **AI Style to Avoid**: "She went to the market. She bought some vegetables. She returned home."
|
||||
- **Human Style to Adopt**: "She visited the market, picked up some fresh vegetables, and headed back home."
|
||||
|
||||
### **Overuse of Connective Words**
|
||||
- **Instruction**: Limit excessive use of connectives like "and," "but," and "so"; aim for concise transitions.
|
||||
- **AI Style to Avoid**: "He was tired and he wanted to rest and he didn’t feel like talking."
|
||||
- **Human Style to Adopt**: "Exhausted, he wanted to rest and preferred silence."
|
||||
|
||||
### **Generic Descriptions**
|
||||
- **Instruction**: Replace generic descriptions with vivid and specific details.
|
||||
- **AI Style to Avoid**: "The garden was beautiful."
|
||||
- **Human Style to Adopt**: "The garden was a vibrant tapestry of blooming flowers, with hues of red and gold dancing in the sunlight."
|
||||
|
||||
### **Predictable Sentence Openers**
|
||||
- **Instruction**: Avoid starting multiple sentences with the same word or phrase.
|
||||
- **AI Style to Avoid**: "I think this idea is great. I think we should implement it. I think it will work."
|
||||
- **Human Style to Adopt**: "This idea seems promising. Implementation could yield excellent results. Success feels within reach."
|
||||
|
||||
### **Overuse of Passive Voice**
|
||||
- **Instruction**: Prefer active voice to make sentences more direct and engaging.
|
||||
- **AI Style to Avoid**: "The decision was made by the team to postpone the event."
|
||||
- **Human Style to Adopt**: "The team decided to postpone the event."
|
||||
|
||||
### **Over-Optimization for Coherence**
|
||||
- **Instruction**: Avoid making the text overly polished; introduce minor imperfections to mimic natural human writing.
|
||||
- **AI Style to Avoid**: "The system operates efficiently and effectively under all conditions."
|
||||
- **Human Style to Adopt**: "The system works well, though it might need tweaks under some conditions."
|
||||
|
||||
### **Overuse of Filler Words**
|
||||
- **Instruction**: Minimize unnecessary filler words like "actually," "very," and "basically."
|
||||
- **AI Style to Avoid**: "This is actually a very good point to consider."
|
||||
- **Human Style to Adopt**: "This is an excellent point to consider."
|
||||
|
||||
### **Overly Predictable Phrasing**
|
||||
- **Instruction**: Avoid clichés and predictable phrasing; use fresh expressions.
|
||||
- **AI Style to Avoid**: "It was a dark and stormy night."
|
||||
- **Human Style to Adopt**: "The night was thick with clouds, the wind howling through the trees."
|
||||
|
||||
### **Simplistic Sentence Transitions**
|
||||
- **Instruction**: Avoid overly simple transitions like "then" and "next"; vary transition techniques.
|
||||
- **AI Style to Avoid**: "He finished his work. Then, he went home."
|
||||
- **Human Style to Adopt**: "After wrapping up his work, he made his way home."
|
||||
|
||||
### **Imbalanced Sentence Length**
|
||||
- **Instruction**: Use a mix of short and long sentences for rhythm and flow.
|
||||
- **AI Style to Avoid**: "The party was fun. Everyone had a great time. We played games and ate snacks."
|
||||
- **Human Style to Adopt**: "The party was a blast. Laughter echoed as we played games, and the snacks were a hit."
|
||||
|
||||
### **Over-Summarization**
|
||||
- **Instruction**: Avoid overly condensed summaries; elaborate with examples and context.
|
||||
- **AI Style to Avoid**: "The book was interesting."
|
||||
- **Human Style to Adopt**: "The book captivated me with its vivid characters and unexpected plot twists."
|
||||
|
||||
### **Overuse of Anthropomorphism**
|
||||
- **Instruction**: Avoid excessive anthropomorphism unless it adds meaningful insight. Opt for factual descriptions with engaging detail.
|
||||
- **AI Style to Avoid**: "Spinning spreads their scent, like saying, 'This is mine!'"
|
||||
- **Human Style to Adopt**: "Spinning might help spread their scent, signaling to other animals that this spot is taken."
|
||||
|
||||
### **Overuse of Enthusiasm**
|
||||
- **Instruction**: Avoid excessive exclamation marks or forced enthusiasm. Use a balanced tone to maintain authenticity.
|
||||
- **AI Style to Avoid**: "It's a fun little mystery to solve together!"
|
||||
- **Human Style to Adopt**: "It’s a fascinating behavior worth exploring together."
|
||||
|
||||
### **Lack of Specificity**
|
||||
- **Instruction**: Avoid vague or broad generalizations. Provide specific examples or details to add depth to your explanation.
|
||||
- **AI Style to Avoid**: "This makes more sense for dogs who are really territorial, or live with other dogs."
|
||||
- **Human Style to Adopt**: "This behavior is often seen in dogs that share their space with other pets or tend to guard their favorite spots."
|
||||
|
||||
### **Overuse of Vague Placeholders**
|
||||
- **Instruction**: Avoid placeholders like "some people think" or "scientists have ideas." Instead, hint at specific theories or details.
|
||||
- **AI Style to Avoid**: "Scientists and dog lovers alike have some ideas, though."
|
||||
- **Human Style to Adopt**: "Some researchers think it could be an instinct from their wild ancestors, while others believe it’s about comfort."
|
||||
|
||||
### **Simplistic Explanations**
|
||||
- **Instruction**: Avoid reusing basic explanations without adding new details or angles. Expand with context, examples, or alternative interpretations.
|
||||
- **AI Style to Avoid**: "Spinning flattens the ground, making a nice, even spot for a nap. You see this a lot in dogs who are picky about where they sleep."
|
||||
- **Human Style to Adopt**: "Dogs may spin to prepare their resting spot. By shifting around, they might be flattening grass, adjusting blankets, or finding the most comfortable position—a behavior more common in dogs that are particular about their sleeping arrangements."
|
||||
|
||||
# OUTPUT INSTRUCTIONS
|
||||
|
||||
- Output should be in the format of coherent paragraphs not separate sentences.
|
||||
- Only output the rewritten text.
|
||||
@@ -21,19 +21,19 @@ This pattern generates a summary of an academic paper based on the provided text
|
||||
|
||||
Copy the paper text to the clipboard and execute the following command:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
pbpaste | fabric --pattern summarize_paper
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
pbpaste | summarize_paper
|
||||
```
|
||||
|
||||
# Example output:
|
||||
|
||||
``` markdown
|
||||
```markdown
|
||||
### Title and authors of the Paper:
|
||||
**Internet of Paint (IoP): Channel Modeling and Capacity Analysis for Terahertz Electromagnetic Nanonetworks Embedded in Paint**
|
||||
Authors: Lasantha Thakshila Wedage, Mehmet C. Vuran, Bernard Butler, Yevgeni Koucheryavy, Sasitharan Balasubramaniam
|
||||
|
||||
@@ -8,7 +8,7 @@ Take a step back, and breathe deeply and think step by step about how to achieve
|
||||
|
||||
- The original format of the input must remain intact.
|
||||
|
||||
- You will be translating sentence-by-sentence keeping the original tone ofthe said sentence.
|
||||
- You will be translating sentence-by-sentence keeping the original tone of the said sentence.
|
||||
|
||||
- You will not be manipulate the wording to change the meaning.
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
"1.4.109"
|
||||
"1.4.128"
|
||||
|
||||
@@ -6,9 +6,12 @@ import (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/danielmiessler/fabric/common"
|
||||
"github.com/danielmiessler/fabric/plugins/template"
|
||||
)
|
||||
|
||||
const inputSentinel = "__FABRIC_INPUT_SENTINEL_TOKEN__"
|
||||
|
||||
type PatternsEntity struct {
|
||||
*StorageEntity
|
||||
SystemPatternFile string
|
||||
@@ -22,50 +25,66 @@ type Pattern struct {
|
||||
Pattern string
|
||||
}
|
||||
|
||||
// main entry point for getting patterns from any source
|
||||
func (o *PatternsEntity) GetApplyVariables(source string, variables map[string]string, input string) (*Pattern, error) {
|
||||
var pattern *Pattern
|
||||
var err error
|
||||
// GetApplyVariables main entry point for getting patterns from any source
|
||||
func (o *PatternsEntity) GetApplyVariables(
|
||||
source string, variables map[string]string, input string) (pattern *Pattern, err error) {
|
||||
|
||||
// Determine if this is a file path
|
||||
isFilePath := strings.HasPrefix(source, "\\") ||
|
||||
strings.HasPrefix(source, "/") ||
|
||||
strings.HasPrefix(source, "~") ||
|
||||
strings.HasPrefix(source, ".")
|
||||
|
||||
if isFilePath {
|
||||
pattern, err = o.getFromFile(source)
|
||||
} else {
|
||||
pattern, err = o.getFromDB(source)
|
||||
}
|
||||
// Determine if this is a file path
|
||||
isFilePath := strings.HasPrefix(source, "\\") ||
|
||||
strings.HasPrefix(source, "/") ||
|
||||
strings.HasPrefix(source, "~") ||
|
||||
strings.HasPrefix(source, ".")
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
pattern, err = o.applyVariables(pattern, variables, input)
|
||||
if isFilePath {
|
||||
// Resolve the file path using GetAbsolutePath
|
||||
absPath, err := common.GetAbsolutePath(source)
|
||||
if err != nil {
|
||||
return nil, err // Return the error if applyVariables failed
|
||||
return nil, fmt.Errorf("could not resolve file path: %v", err)
|
||||
}
|
||||
return pattern, nil
|
||||
|
||||
// Use the resolved absolute path to get the pattern
|
||||
pattern, err = o.getFromFile(absPath)
|
||||
} else {
|
||||
// Otherwise, get the pattern from the database
|
||||
pattern, err = o.getFromDB(source)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// Apply variables to the pattern
|
||||
err = o.applyVariables(pattern, variables, input)
|
||||
return
|
||||
}
|
||||
|
||||
func (o *PatternsEntity) applyVariables(
|
||||
pattern *Pattern, variables map[string]string, input string) (err error) {
|
||||
|
||||
func (o *PatternsEntity) applyVariables(pattern *Pattern, variables map[string]string, input string) (*Pattern, error) {
|
||||
// If {{input}} isn't in pattern, append it on new line
|
||||
// Ensure pattern has an {{input}} placeholder
|
||||
// If not present, append it on a new line
|
||||
if !strings.Contains(pattern.Pattern, "{{input}}") {
|
||||
if !strings.HasSuffix(pattern.Pattern, "\n") {
|
||||
pattern.Pattern += "\n"
|
||||
}
|
||||
pattern.Pattern += "{{input}}"
|
||||
if !strings.HasSuffix(pattern.Pattern, "\n") {
|
||||
pattern.Pattern += "\n"
|
||||
}
|
||||
pattern.Pattern += "{{input}}"
|
||||
}
|
||||
|
||||
result, err := template.ApplyTemplate(pattern.Pattern, variables, input)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
// Temporarily replace {{input}} with a sentinel token to protect it
|
||||
// from recursive variable resolution
|
||||
withSentinel := strings.ReplaceAll(pattern.Pattern, "{{input}}", inputSentinel)
|
||||
|
||||
// Process all other template variables in the pattern
|
||||
// At this point, our sentinel ensures {{input}} won't be affected
|
||||
var processed string
|
||||
if processed, err = template.ApplyTemplate(withSentinel, variables, ""); err != nil {
|
||||
return
|
||||
}
|
||||
pattern.Pattern = result
|
||||
return pattern, nil
|
||||
|
||||
// Finally, replace our sentinel with the actual user input
|
||||
// The input has already been processed for variables if InputHasVars was true
|
||||
pattern.Pattern = strings.ReplaceAll(processed, inputSentinel, input)
|
||||
return
|
||||
}
|
||||
|
||||
// retrieves a pattern from the database by name
|
||||
@@ -103,29 +122,31 @@ func (o *PatternsEntity) PrintLatestPatterns(latestNumber int) (err error) {
|
||||
}
|
||||
|
||||
// reads a pattern from a file path and returns it
|
||||
func (o *PatternsEntity) getFromFile(pathStr string) (*Pattern, error) {
|
||||
func (o *PatternsEntity) getFromFile(pathStr string) (pattern *Pattern, err error) {
|
||||
// Handle home directory expansion
|
||||
if strings.HasPrefix(pathStr, "~/") {
|
||||
homedir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not get home directory: %v", err)
|
||||
}
|
||||
pathStr = filepath.Join(homedir, pathStr[2:])
|
||||
var homedir string
|
||||
if homedir, err = os.UserHomeDir(); err != nil {
|
||||
err = fmt.Errorf("could not get home directory: %v", err)
|
||||
return
|
||||
}
|
||||
pathStr = filepath.Join(homedir, pathStr[2:])
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(pathStr)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not read pattern file %s: %v", pathStr, err)
|
||||
var content []byte
|
||||
if content, err = os.ReadFile(pathStr); err != nil {
|
||||
err = fmt.Errorf("could not read pattern file %s: %v", pathStr, err)
|
||||
return
|
||||
}
|
||||
|
||||
return &Pattern{
|
||||
Name: pathStr,
|
||||
Pattern: string(content),
|
||||
}, nil
|
||||
pattern = &Pattern{
|
||||
Name: pathStr,
|
||||
Pattern: string(content),
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Get required for Storage interface
|
||||
func (o *PatternsEntity) Get(name string) (*Pattern, error) {
|
||||
// Use GetPattern with no variables
|
||||
return o.GetApplyVariables(name, nil, "")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -43,7 +43,7 @@ func createTestPattern(t *testing.T, entity *PatternsEntity, name, content strin
|
||||
|
||||
func TestApplyVariables(t *testing.T) {
|
||||
entity := &PatternsEntity{}
|
||||
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
pattern *Pattern
|
||||
@@ -79,15 +79,15 @@ func TestApplyVariables(t *testing.T) {
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result, err := entity.applyVariables(tt.pattern, tt.variables, tt.input)
|
||||
|
||||
err := entity.applyVariables(tt.pattern, tt.variables, tt.input)
|
||||
|
||||
if tt.wantErr {
|
||||
assert.Error(t, err)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.want, result.Pattern)
|
||||
assert.Equal(t, tt.want, tt.pattern.Pattern)
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -117,15 +117,15 @@ func TestGetApplyVariables(t *testing.T) {
|
||||
want: "You are a reviewer.\ncheck this code",
|
||||
},
|
||||
{
|
||||
name: "pattern with missing variable",
|
||||
source: "test-pattern",
|
||||
name: "pattern with missing variable",
|
||||
source: "test-pattern",
|
||||
variables: map[string]string{},
|
||||
input: "test input",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "non-existent pattern",
|
||||
source: "non-existent",
|
||||
name: "non-existent pattern",
|
||||
source: "non-existent",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
@@ -133,14 +133,14 @@ func TestGetApplyVariables(t *testing.T) {
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result, err := entity.GetApplyVariables(tt.source, tt.variables, tt.input)
|
||||
|
||||
|
||||
if tt.wantErr {
|
||||
assert.Error(t, err)
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, tt.want, result.Pattern)
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -58,8 +58,7 @@ func (o *Session) Append(messages ...*goopenai.ChatCompletionMessage) {
|
||||
}
|
||||
|
||||
func (o *Session) GetVendorMessages() (ret []*goopenai.ChatCompletionMessage) {
|
||||
if o.vendorMessages == nil {
|
||||
o.vendorMessages = []*goopenai.ChatCompletionMessage{}
|
||||
if len(o.vendorMessages) == 0 {
|
||||
for _, message := range o.Messages {
|
||||
o.appendVendorMessage(message)
|
||||
}
|
||||
|
||||
@@ -7,7 +7,7 @@ import (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/samber/lo"
|
||||
"github.com/danielmiessler/fabric/common"
|
||||
)
|
||||
|
||||
type StorageEntity struct {
|
||||
@@ -26,37 +26,44 @@ func (o *StorageEntity) Configure() (err error) {
|
||||
|
||||
// GetNames finds all patterns in the patterns directory and enters the id, name, and pattern into a slice of Entry structs. it returns these entries or an error
|
||||
func (o *StorageEntity) GetNames() (ret []string, err error) {
|
||||
var entries []os.DirEntry
|
||||
if entries, err = os.ReadDir(o.Dir); err != nil {
|
||||
err = fmt.Errorf("could not read items from directory: %v", err)
|
||||
return
|
||||
// Resolve the directory path to an absolute path
|
||||
absDir, err := common.GetAbsolutePath(o.Dir)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not resolve directory path: %v", err)
|
||||
}
|
||||
|
||||
if o.ItemIsDir {
|
||||
ret = lo.FilterMap(entries, func(item os.DirEntry, index int) (ret string, ok bool) {
|
||||
if ok = item.IsDir(); ok {
|
||||
ret = item.Name()
|
||||
// Read the directory entries
|
||||
var entries []os.DirEntry
|
||||
if entries, err = os.ReadDir(absDir); err != nil {
|
||||
return nil, fmt.Errorf("could not read items from directory: %v", err)
|
||||
}
|
||||
|
||||
for _, entry := range entries {
|
||||
entryPath := filepath.Join(absDir, entry.Name())
|
||||
|
||||
// Get metadata for the entry, including symlink info
|
||||
fileInfo, err := os.Lstat(entryPath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not stat entry %s: %v", entryPath, err)
|
||||
}
|
||||
|
||||
// Determine if the entry should be included
|
||||
if o.ItemIsDir {
|
||||
// Include directories or symlinks to directories
|
||||
if fileInfo.IsDir() || (fileInfo.Mode()&os.ModeSymlink != 0 && common.IsSymlinkToDir(entryPath)) {
|
||||
ret = append(ret, entry.Name())
|
||||
}
|
||||
return
|
||||
})
|
||||
} else {
|
||||
if o.FileExtension == "" {
|
||||
ret = lo.FilterMap(entries, func(item os.DirEntry, index int) (ret string, ok bool) {
|
||||
if ok = !item.IsDir(); ok {
|
||||
ret = item.Name()
|
||||
}
|
||||
return
|
||||
})
|
||||
} else {
|
||||
ret = lo.FilterMap(entries, func(item os.DirEntry, index int) (ret string, ok bool) {
|
||||
if ok = !item.IsDir() && filepath.Ext(item.Name()) == o.FileExtension; ok {
|
||||
ret = strings.TrimSuffix(item.Name(), o.FileExtension)
|
||||
// Include files, optionally filtering by extension
|
||||
if !fileInfo.IsDir() {
|
||||
if o.FileExtension == "" || filepath.Ext(entry.Name()) == o.FileExtension {
|
||||
ret = append(ret, strings.TrimSuffix(entry.Name(), o.FileExtension))
|
||||
}
|
||||
return
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
return
|
||||
|
||||
return ret, nil
|
||||
}
|
||||
|
||||
func (o *StorageEntity) Delete(name string) (err error) {
|
||||
|
||||
223
plugins/template/Examples/README.md
Normal file
223
plugins/template/Examples/README.md
Normal file
@@ -0,0 +1,223 @@
|
||||
|
||||
# Fabric Extensions: Complete Guide
|
||||
|
||||
## Understanding Extension Architecture
|
||||
|
||||
### Registry Structure
|
||||
The extension registry is stored at `~/.config/fabric/extensions/extensions.yaml` and tracks registered extensions:
|
||||
|
||||
```yaml
|
||||
extensions:
|
||||
extension-name:
|
||||
config_path: /path/to/config.yaml
|
||||
config_hash: <sha256>
|
||||
executable_hash: <sha256>
|
||||
```
|
||||
|
||||
The registry maintains security through hash verification of both configs and executables.
|
||||
|
||||
### Extension Configuration
|
||||
Each extension requires a YAML configuration file with the following structure:
|
||||
|
||||
```yaml
|
||||
name: "extension-name" # Unique identifier
|
||||
executable: "/path/to/binary" # Full path to executable
|
||||
type: "executable" # Type of extension
|
||||
timeout: "30s" # Execution timeout
|
||||
description: "Description" # What the extension does
|
||||
version: "1.0.0" # Version number
|
||||
env: [] # Optional environment variables
|
||||
|
||||
operations: # Defined operations
|
||||
operation-name:
|
||||
cmd_template: "{{executable}} {{operation}} {{value}}"
|
||||
|
||||
config: # Output configuration
|
||||
output:
|
||||
method: "stdout" # or "file"
|
||||
file_config: # Optional, for file output
|
||||
cleanup: true
|
||||
path_from_stdout: true
|
||||
work_dir: "/tmp"
|
||||
```
|
||||
|
||||
### Directory Structure
|
||||
Recommended organization:
|
||||
```
|
||||
~/.config/fabric/extensions/
|
||||
├── bin/ # Extension executables
|
||||
├── configs/ # Extension YAML configs
|
||||
└── extensions.yaml # Registry file
|
||||
```
|
||||
|
||||
## Example 1: Python Wrapper (Word Generator)
|
||||
A simple example wrapping a Python script.
|
||||
|
||||
### 1. Position Files
|
||||
```bash
|
||||
# Create directories
|
||||
mkdir -p ~/.config/fabric/extensions/{bin,configs}
|
||||
|
||||
# Install script
|
||||
cp word-generator.py ~/.config/fabric/extensions/bin/
|
||||
chmod +x ~/.config/fabric/extensions/bin/word-generator.py
|
||||
```
|
||||
|
||||
### 2. Configure
|
||||
Create `~/.config/fabric/extensions/configs/word-generator.yaml`:
|
||||
```yaml
|
||||
name: word-generator
|
||||
executable: "~/.config/fabric/extensions/bin/word-generator.py"
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Generates random words based on count parameter"
|
||||
version: "1.0.0"
|
||||
|
||||
operations:
|
||||
generate:
|
||||
cmd_template: "{{executable}} {{value}}"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
```
|
||||
|
||||
### 3. Register & Run
|
||||
```bash
|
||||
# Register
|
||||
fabric --addextension ~/.config/fabric/extensions/configs/word-generator.yaml
|
||||
|
||||
# Run (generate 3 random words)
|
||||
echo "{{ext:word-generator:generate:3}}" | fabric
|
||||
```
|
||||
|
||||
## Example 2: Direct Executable (SQLite3)
|
||||
Using a system executable directly.
|
||||
|
||||
copy the memories to your home directory
|
||||
~/memories.db
|
||||
|
||||
### 1. Configure
|
||||
Create `~/.config/fabric/extensions/configs/memory-query.yaml`:
|
||||
```yaml
|
||||
name: memory-query
|
||||
executable: "/usr/bin/sqlite3"
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Query memories database"
|
||||
version: "1.0.0"
|
||||
|
||||
operations:
|
||||
goal:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories where type= 'goal'\""
|
||||
value:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories where type= 'value'\""
|
||||
byid:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories where uid= {{value}}\""
|
||||
all:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories\""
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
```
|
||||
|
||||
### 2. Register & Run
|
||||
```bash
|
||||
# Register
|
||||
fabric --addextension ~/.config/fabric/extensions/configs/memory-query.yaml
|
||||
|
||||
# Run queries
|
||||
echo "{{ext:memory-query:all}}" | fabric
|
||||
echo "{{ext:memory-query:byid:3}}" | fabric
|
||||
```
|
||||
|
||||
|
||||
## Extension Management Commands
|
||||
|
||||
### Add Extension
|
||||
```bash
|
||||
fabric --addextension ~/.config/fabric/extensions/configs/memory-query.yaml
|
||||
```
|
||||
|
||||
Note : if the executable or config file changes, you must re-add the extension.
|
||||
This will recompute the hash for the extension.
|
||||
|
||||
|
||||
### List Extensions
|
||||
```bash
|
||||
fabric --listextensions
|
||||
```
|
||||
Shows all registered extensions with their status and configuration details.
|
||||
|
||||
### Remove Extension
|
||||
```bash
|
||||
fabric --rmextension <extension-name>
|
||||
```
|
||||
Removes an extension from the registry.
|
||||
|
||||
|
||||
## Extensions in patterns
|
||||
|
||||
```
|
||||
Create a pattern that use multiple extensions.
|
||||
|
||||
These are my favorite
|
||||
{{ext:word-generator:generate:3}}
|
||||
|
||||
These are my least favorite
|
||||
{{ext:word-generator:generate:2}}
|
||||
|
||||
what does this say about me?
|
||||
```
|
||||
|
||||
```bash
|
||||
./fabric -p ./plugins/template/Examples/test_pattern.md
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
1. **Hash Verification**
|
||||
- Both configs and executables are verified via SHA-256 hashes
|
||||
- Changes to either require re-registration
|
||||
- Prevents tampering with registered extensions
|
||||
|
||||
2. **Execution Safety**
|
||||
- Extensions run with user permissions
|
||||
- Timeout constraints prevent runaway processes
|
||||
- Environment variables can be controlled via config
|
||||
|
||||
3. **Best Practices**
|
||||
- Review extension code before installation
|
||||
- Keep executables in protected directories
|
||||
- Use absolute paths in configurations
|
||||
- Implement proper error handling in scripts
|
||||
- Regular security audits of registered extensions
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
1. **Registration Failures**
|
||||
- Verify file permissions
|
||||
- Check executable paths
|
||||
- Validate YAML syntax
|
||||
|
||||
2. **Execution Errors**
|
||||
- Check operation exists in config
|
||||
- Verify timeout settings
|
||||
- Monitor system resources
|
||||
- Check extension logs
|
||||
|
||||
3. **Output Issues**
|
||||
- Verify output method configuration
|
||||
- Check file permissions for file output
|
||||
- Monitor disk space for file operations
|
||||
|
||||
### Debug Tips
|
||||
1. Enable verbose logging when available
|
||||
2. Check system logs for execution errors
|
||||
3. Verify extension dependencies
|
||||
4. Test extensions with minimal configurations first
|
||||
|
||||
|
||||
Would you like me to expand on any particular section or add more examples?
|
||||
BIN
plugins/template/Examples/memories.db
Normal file
BIN
plugins/template/Examples/memories.db
Normal file
Binary file not shown.
24
plugins/template/Examples/remote-security-report.sh
Executable file
24
plugins/template/Examples/remote-security-report.sh
Executable file
@@ -0,0 +1,24 @@
|
||||
#!/bin/bash
|
||||
# remote-security-report.sh
|
||||
# Usage: remote-security-report.sh cert host [report_name]
|
||||
|
||||
cert_path="$1"
|
||||
host="$2"
|
||||
report_name="${3:-report}"
|
||||
temp_file="/tmp/security-report-${report_name}.txt"
|
||||
|
||||
# Copy the security report script to remote host
|
||||
scp -i "$cert_path" /usr/local/bin/security-report.sh "${host}:~/security-report.sh" >&2
|
||||
|
||||
# Make it executable and run it on remote host
|
||||
ssh -i "$cert_path" "$host" "chmod +x ~/security-report.sh && sudo ~/security-report.sh ${temp_file}" >&2
|
||||
|
||||
# Copy the report back
|
||||
scp -i "$cert_path" "${host}:${temp_file}" "${temp_file}" >&2
|
||||
|
||||
# Cleanup remote files
|
||||
ssh -i "$cert_path" "$host" "rm ~/security-report.sh ${temp_file}" >&2
|
||||
|
||||
# Output the local file path for fabric to read
|
||||
echo "${temp_file}"
|
||||
|
||||
17
plugins/template/Examples/remote-security-report.yaml
Normal file
17
plugins/template/Examples/remote-security-report.yaml
Normal file
@@ -0,0 +1,17 @@
|
||||
name: "remote-security"
|
||||
executable: "/usr/local/bin/remote-security-report.sh"
|
||||
type: "executable"
|
||||
timeout: "60s"
|
||||
description: "Generate security report from remote system"
|
||||
|
||||
operations:
|
||||
report:
|
||||
cmd_template: "{{executable}} {{1}} {{2}} {{3}}"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: "file"
|
||||
file_config:
|
||||
cleanup: true
|
||||
path_from_stdout: true
|
||||
work_dir: "/tmp"
|
||||
113
plugins/template/Examples/security-report.sh
Executable file
113
plugins/template/Examples/security-report.sh
Executable file
@@ -0,0 +1,113 @@
|
||||
#!/bin/bash
|
||||
|
||||
# security-report.sh - Enhanced system security information collection
|
||||
# Usage: security-report.sh [output_file]
|
||||
|
||||
output_file=${1:-/tmp/security-report.txt}
|
||||
|
||||
{
|
||||
echo "=== System Security Report ==="
|
||||
echo "Generated: $(date)"
|
||||
echo "Hostname: $(hostname)"
|
||||
echo "Kernel: $(uname -r)"
|
||||
echo
|
||||
|
||||
echo "=== System Updates ==="
|
||||
echo "Last update: $(stat -c %y /var/cache/apt/pkgcache.bin | cut -d' ' -f1)"
|
||||
echo "Pending updates:"
|
||||
apt list --upgradable 2>/dev/null
|
||||
|
||||
echo -e "\n=== Security Updates ==="
|
||||
echo "Pending security updates:"
|
||||
apt list --upgradable 2>/dev/null | grep -i security
|
||||
|
||||
echo -e "\n=== User Accounts ==="
|
||||
echo "Users with login shells:"
|
||||
grep -v '/nologin\|/false' /etc/passwd
|
||||
echo -e "\nUsers who can login:"
|
||||
awk -F: '$2!="*" && $2!="!" {print $1}' /etc/shadow
|
||||
echo -e "\nUsers with empty passwords:"
|
||||
awk -F: '$2=="" {print $1}' /etc/shadow
|
||||
echo -e "\nUsers with UID 0:"
|
||||
awk -F: '$3==0 {print $1}' /etc/passwd
|
||||
|
||||
echo -e "\n=== Sudo Configuration ==="
|
||||
echo "Users/groups with sudo privileges:"
|
||||
grep -h '^[^#]' /etc/sudoers.d/* /etc/sudoers 2>/dev/null
|
||||
echo -e "\nUsers with passwordless sudo:"
|
||||
grep -h NOPASSWD /etc/sudoers.d/* /etc/sudoers 2>/dev/null
|
||||
|
||||
echo -e "\n=== SSH Configuration ==="
|
||||
if [ -f /etc/ssh/sshd_config ]; then
|
||||
echo "Key SSH settings:"
|
||||
grep -E '^(PermitRootLogin|PasswordAuthentication|Port|Protocol|X11Forwarding|MaxAuthTries|PermitEmptyPasswords)' /etc/ssh/sshd_config
|
||||
fi
|
||||
|
||||
echo -e "\n=== SSH Keys ==="
|
||||
echo "Authorized keys found:"
|
||||
find /home -name "authorized_keys" -ls 2>/dev/null
|
||||
|
||||
echo -e "\n=== Firewall Status ==="
|
||||
echo "UFW Status:"
|
||||
ufw status verbose
|
||||
echo -e "\nIPTables Rules:"
|
||||
iptables -L -n
|
||||
|
||||
echo -e "\n=== Network Services ==="
|
||||
echo "Listening services (port - process):"
|
||||
netstat -tlpn 2>/dev/null | grep LISTEN
|
||||
|
||||
echo -e "\n=== Recent Authentication Failures ==="
|
||||
echo "Last 5 failed SSH attempts:"
|
||||
grep "Failed password" /var/log/auth.log | tail -5
|
||||
|
||||
echo -e "\n=== File Permissions ==="
|
||||
echo "World-writable files in /etc:"
|
||||
find /etc -type f -perm -002 -ls 2>/dev/null
|
||||
echo -e "\nWorld-writable directories in /etc:"
|
||||
find /etc -type d -perm -002 -ls 2>/dev/null
|
||||
|
||||
echo -e "\n=== System Resource Usage ==="
|
||||
echo "Disk Usage:"
|
||||
df -h
|
||||
echo -e "\nMemory Usage:"
|
||||
free -h
|
||||
echo -e "\nTop 5 CPU-using processes:"
|
||||
ps aux --sort=-%cpu | head -6
|
||||
|
||||
echo -e "\n=== System Timers ==="
|
||||
echo "Active timers (potential scheduled tasks):"
|
||||
systemctl list-timers --all
|
||||
|
||||
echo -e "\n=== Important Service Status ==="
|
||||
for service in ssh ufw apparmor fail2ban clamav-freshclam; do
|
||||
echo "Status of $service:"
|
||||
systemctl status $service --no-pager 2>/dev/null
|
||||
done
|
||||
|
||||
echo -e "\n=== Fail2Ban Logs ==="
|
||||
echo "Recent Fail2Ban activity (fail2ban.log):"
|
||||
if [ -f /var/log/fail2ban.log ]; then
|
||||
echo "=== Current log (fail2ban.log) ==="
|
||||
cat /var/log/fail2ban.log
|
||||
else
|
||||
echo "fail2ban.log not found"
|
||||
fi
|
||||
|
||||
if [ -f /var/log/fail2ban.log.1 ]; then
|
||||
echo -e "\n=== Previous log (fail2ban.log.1) ==="
|
||||
cat /var/log/fail2ban.log.1
|
||||
else
|
||||
echo -e "\nfail2ban.log.1 not found"
|
||||
fi
|
||||
|
||||
echo -e "\n=== Fail2Ban Status ==="
|
||||
echo "Currently banned IPs:"
|
||||
sudo fail2ban-client status
|
||||
|
||||
|
||||
} > "$output_file"
|
||||
|
||||
# Output the file path for fabric to read
|
||||
echo "$output_file"
|
||||
|
||||
18
plugins/template/Examples/security-report.yaml
Normal file
18
plugins/template/Examples/security-report.yaml
Normal file
@@ -0,0 +1,18 @@
|
||||
name: "security-report"
|
||||
executable: "/usr/local/bin/security-report.sh"
|
||||
type: "executable"
|
||||
timeout: "30s"
|
||||
description: "Generate system security report"
|
||||
version: "1.0.0"
|
||||
|
||||
operations:
|
||||
generate:
|
||||
cmd_template: "{{executable}} /tmp/security-report-{{1}}.txt"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: "file"
|
||||
file_config:
|
||||
cleanup: true
|
||||
path_from_stdout: true
|
||||
work_dir: "/tmp"
|
||||
23
plugins/template/Examples/sqlite3_demo.yaml
Normal file
23
plugins/template/Examples/sqlite3_demo.yaml
Normal file
@@ -0,0 +1,23 @@
|
||||
name: memory-query
|
||||
executable: /usr/bin/sqlite3
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Query memories database"
|
||||
version: "1.0.0"
|
||||
env: []
|
||||
|
||||
operations:
|
||||
goal:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where type= 'goal'\""
|
||||
value:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where type= 'value'\""
|
||||
project:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where type= 'project'\""
|
||||
byid:
|
||||
cmd_template: "{{executable}} -json /home/matt/memories.db \"select * from memories where uid= {{value}}\""
|
||||
all:
|
||||
cmd_template: "{{executable}} -json ~/memories.db \"select * from memories\""
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
8
plugins/template/Examples/test_pattern.md
Normal file
8
plugins/template/Examples/test_pattern.md
Normal file
@@ -0,0 +1,8 @@
|
||||
These are my favorite
|
||||
{{ext:word-generator:generate:3}}
|
||||
|
||||
These are my least favorite
|
||||
{{ext:word-generator:generate:2}}
|
||||
|
||||
what does this say about me?
|
||||
|
||||
18
plugins/template/Examples/track_packages.sh
Executable file
18
plugins/template/Examples/track_packages.sh
Executable file
@@ -0,0 +1,18 @@
|
||||
#!/bin/bash
|
||||
|
||||
LOG_DIR="/var/log/package_tracking"
|
||||
DATE=$(date +%Y%m%d)
|
||||
|
||||
# Ensure directory exists
|
||||
mkdir -p "$LOG_DIR"
|
||||
|
||||
# Current package list
|
||||
dpkg -l > "$LOG_DIR/packages_current.list"
|
||||
|
||||
# Create diff if previous exists
|
||||
if [ -f "$LOG_DIR/packages_previous.list" ]; then
|
||||
diff "$LOG_DIR/packages_previous.list" "$LOG_DIR/packages_current.list" > "$LOG_DIR/changes_current.diff"
|
||||
fi
|
||||
|
||||
# Keep copy for next comparison
|
||||
cp "$LOG_DIR/packages_current.list" "$LOG_DIR/packages_previous.list"
|
||||
36
plugins/template/Examples/word-generator.py
Executable file
36
plugins/template/Examples/word-generator.py
Executable file
@@ -0,0 +1,36 @@
|
||||
#!/usr/bin/env python3
|
||||
import sys
|
||||
import json
|
||||
import random
|
||||
|
||||
# A small set of words for demonstration!
|
||||
WORD_LIST = [
|
||||
"apple", "banana", "cherry", "date", "elderberry",
|
||||
"fig", "grape", "honeydew", "kiwi", "lemon",
|
||||
"mango", "nectarine", "orange", "papaya", "quince",
|
||||
"raspberry", "strawberry", "tangerine", "ugli", "watermelon"
|
||||
]
|
||||
|
||||
def generate_words(count):
|
||||
try:
|
||||
count = int(count)
|
||||
if count < 1:
|
||||
return json.dumps({"error": "Count must be positive"})
|
||||
|
||||
# Generate random words
|
||||
words = random.sample(WORD_LIST, min(count, len(WORD_LIST)))
|
||||
|
||||
# Return JSON formatted result
|
||||
return json.dumps({
|
||||
"words": words,
|
||||
"count": len(words)
|
||||
})
|
||||
except ValueError:
|
||||
return json.dumps({"error": "Invalid count parameter"})
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) != 2:
|
||||
print(json.dumps({"error": "Exactly one argument required"}))
|
||||
sys.exit(1)
|
||||
|
||||
print(generate_words(sys.argv[1]))
|
||||
16
plugins/template/Examples/word-generator.yaml
Normal file
16
plugins/template/Examples/word-generator.yaml
Normal file
@@ -0,0 +1,16 @@
|
||||
name: word-generator
|
||||
executable: /usr/local/bin/word-generator.py
|
||||
type: executable
|
||||
timeout: "5s"
|
||||
description: "Generates random words based on count parameter"
|
||||
version: "1.0.0"
|
||||
env: []
|
||||
|
||||
operations:
|
||||
generate:
|
||||
cmd_template: "{{executable}} {{value}}"
|
||||
|
||||
config:
|
||||
output:
|
||||
method: stdout
|
||||
|
||||
@@ -17,128 +17,128 @@ type DateTimePlugin struct{}
|
||||
// Period: startofweek, endofweek, startofmonth, endofmonth
|
||||
// Relative: rel:-1h, rel:-2d, rel:1w, rel:3m, rel:1y
|
||||
func (p *DateTimePlugin) Apply(operation string, value string) (string, error) {
|
||||
debugf("DateTime: operation=%q value=%q", operation, value)
|
||||
|
||||
now := time.Now()
|
||||
debugf("DateTime: reference time=%v", now)
|
||||
|
||||
switch operation {
|
||||
// Time operations
|
||||
case "now":
|
||||
result := now.Format(time.RFC3339)
|
||||
debugf("DateTime: now=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "time":
|
||||
result := now.Format("15:04:05")
|
||||
debugf("DateTime: time=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "unix":
|
||||
result := fmt.Sprintf("%d", now.Unix())
|
||||
debugf("DateTime: unix=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "startofhour":
|
||||
result := now.Truncate(time.Hour).Format(time.RFC3339)
|
||||
debugf("DateTime: startofhour=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "endofhour":
|
||||
result := now.Truncate(time.Hour).Add(time.Hour - time.Second).Format(time.RFC3339)
|
||||
debugf("DateTime: endofhour=%q", result)
|
||||
return result, nil
|
||||
|
||||
// Date operations
|
||||
case "today":
|
||||
result := now.Format("2006-01-02")
|
||||
debugf("DateTime: today=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "full":
|
||||
result := now.Format("Monday, January 2, 2006")
|
||||
debugf("DateTime: full=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "month":
|
||||
result := now.Format("January")
|
||||
debugf("DateTime: month=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "year":
|
||||
result := now.Format("2006")
|
||||
debugf("DateTime: year=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "startofweek":
|
||||
result := now.AddDate(0, 0, -int(now.Weekday())).Format("2006-01-02")
|
||||
debugf("DateTime: startofweek=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "endofweek":
|
||||
result := now.AddDate(0, 0, 7-int(now.Weekday())).Format("2006-01-02")
|
||||
debugf("DateTime: endofweek=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "startofmonth":
|
||||
result := time.Date(now.Year(), now.Month(), 1, 0, 0, 0, 0, now.Location()).Format("2006-01-02")
|
||||
debugf("DateTime: startofmonth=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "endofmonth":
|
||||
result := time.Date(now.Year(), now.Month()+1, 0, 0, 0, 0, 0, now.Location()).Format("2006-01-02")
|
||||
debugf("DateTime: endofmonth=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "rel":
|
||||
return p.handleRelative(now, value)
|
||||
|
||||
default:
|
||||
return "", fmt.Errorf("datetime: unknown operation %q (see plugin documentation for supported operations)", operation)
|
||||
}
|
||||
debugf("DateTime: operation=%q value=%q", operation, value)
|
||||
|
||||
now := time.Now()
|
||||
debugf("DateTime: reference time=%v", now)
|
||||
|
||||
switch operation {
|
||||
// Time operations
|
||||
case "now":
|
||||
result := now.Format(time.RFC3339)
|
||||
debugf("DateTime: now=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "time":
|
||||
result := now.Format("15:04:05")
|
||||
debugf("DateTime: time=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "unix":
|
||||
result := fmt.Sprintf("%d", now.Unix())
|
||||
debugf("DateTime: unix=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "startofhour":
|
||||
result := now.Truncate(time.Hour).Format(time.RFC3339)
|
||||
debugf("DateTime: startofhour=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "endofhour":
|
||||
result := now.Truncate(time.Hour).Add(time.Hour - time.Second).Format(time.RFC3339)
|
||||
debugf("DateTime: endofhour=%q", result)
|
||||
return result, nil
|
||||
|
||||
// Date operations
|
||||
case "today":
|
||||
result := now.Format("2006-01-02")
|
||||
debugf("DateTime: today=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "full":
|
||||
result := now.Format("Monday, January 2, 2006")
|
||||
debugf("DateTime: full=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "month":
|
||||
result := now.Format("January")
|
||||
debugf("DateTime: month=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "year":
|
||||
result := now.Format("2006")
|
||||
debugf("DateTime: year=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "startofweek":
|
||||
result := now.AddDate(0, 0, -int(now.Weekday())).Format("2006-01-02")
|
||||
debugf("DateTime: startofweek=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "endofweek":
|
||||
result := now.AddDate(0, 0, 7-int(now.Weekday())).Format("2006-01-02")
|
||||
debugf("DateTime: endofweek=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "startofmonth":
|
||||
result := time.Date(now.Year(), now.Month(), 1, 0, 0, 0, 0, now.Location()).Format("2006-01-02")
|
||||
debugf("DateTime: startofmonth=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "endofmonth":
|
||||
result := time.Date(now.Year(), now.Month()+1, 0, 0, 0, 0, 0, now.Location()).Format("2006-01-02")
|
||||
debugf("DateTime: endofmonth=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "rel":
|
||||
return p.handleRelative(now, value)
|
||||
|
||||
default:
|
||||
return "", fmt.Errorf("datetime: unknown operation %q (see plugin documentation for supported operations)", operation)
|
||||
}
|
||||
}
|
||||
|
||||
func (p *DateTimePlugin) handleRelative(now time.Time, value string) (string, error) {
|
||||
debugf("DateTime: handling relative time value=%q", value)
|
||||
|
||||
if value == "" {
|
||||
return "", fmt.Errorf("datetime: relative time requires a value (e.g., -1h, -1d, -1w)")
|
||||
}
|
||||
|
||||
// Try standard duration first (hours, minutes)
|
||||
if duration, err := time.ParseDuration(value); err == nil {
|
||||
result := now.Add(duration).Format(time.RFC3339)
|
||||
debugf("DateTime: relative duration=%q result=%q", duration, result)
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// Handle date units
|
||||
if len(value) < 2 {
|
||||
return "", fmt.Errorf("datetime: invalid relative format (use: -1h, 2d, -3w, 1m, -1y)")
|
||||
}
|
||||
|
||||
unit := value[len(value)-1:]
|
||||
numStr := value[:len(value)-1]
|
||||
|
||||
num, err := strconv.Atoi(numStr)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("datetime: invalid number in relative time: %q", value)
|
||||
}
|
||||
|
||||
var result string
|
||||
switch unit {
|
||||
case "d":
|
||||
result = now.AddDate(0, 0, num).Format("2006-01-02")
|
||||
case "w":
|
||||
result = now.AddDate(0, 0, num*7).Format("2006-01-02")
|
||||
case "m":
|
||||
result = now.AddDate(0, num, 0).Format("2006-01-02")
|
||||
case "y":
|
||||
result = now.AddDate(num, 0, 0).Format("2006-01-02")
|
||||
default:
|
||||
return "", fmt.Errorf("datetime: invalid unit %q (use: h,m for time or d,w,m,y for date)", unit)
|
||||
}
|
||||
|
||||
debugf("DateTime: relative unit=%q num=%d result=%q", unit, num, result)
|
||||
return result, nil
|
||||
}
|
||||
debugf("DateTime: handling relative time value=%q", value)
|
||||
|
||||
if value == "" {
|
||||
return "", fmt.Errorf("datetime: relative time requires a value (e.g., -1h, -1d, -1w)")
|
||||
}
|
||||
|
||||
// Try standard duration first (hours, minutes)
|
||||
if duration, err := time.ParseDuration(value); err == nil {
|
||||
result := now.Add(duration).Format(time.RFC3339)
|
||||
debugf("DateTime: relative duration=%q result=%q", duration, result)
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// Handle date units
|
||||
if len(value) < 2 {
|
||||
return "", fmt.Errorf("datetime: invalid relative format (use: -1h, 2d, -3w, 1m, -1y)")
|
||||
}
|
||||
|
||||
unit := value[len(value)-1:]
|
||||
numStr := value[:len(value)-1]
|
||||
|
||||
num, err := strconv.Atoi(numStr)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("datetime: invalid number in relative time: %q", value)
|
||||
}
|
||||
|
||||
var result string
|
||||
switch unit {
|
||||
case "d":
|
||||
result = now.AddDate(0, 0, num).Format("2006-01-02")
|
||||
case "w":
|
||||
result = now.AddDate(0, 0, num*7).Format("2006-01-02")
|
||||
case "m":
|
||||
result = now.AddDate(0, num, 0).Format("2006-01-02")
|
||||
case "y":
|
||||
result = now.AddDate(num, 0, 0).Format("2006-01-02")
|
||||
default:
|
||||
return "", fmt.Errorf("datetime: invalid unit %q (use: h,m for time or d,w,m,y for date)", unit)
|
||||
}
|
||||
|
||||
debugf("DateTime: relative unit=%q num=%d result=%q", unit, num, result)
|
||||
return result, nil
|
||||
}
|
||||
|
||||
@@ -9,130 +9,130 @@ import (
|
||||
)
|
||||
|
||||
func TestDateTimePlugin(t *testing.T) {
|
||||
plugin := &DateTimePlugin{}
|
||||
now := time.Now()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
validate func(string) error
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "now returns RFC3339",
|
||||
operation: "now",
|
||||
validate: func(got string) error {
|
||||
if _, err := time.Parse(time.RFC3339, got); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "time returns HH:MM:SS",
|
||||
operation: "time",
|
||||
validate: func(got string) error {
|
||||
if _, err := time.Parse("15:04:05", got); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "unix returns timestamp",
|
||||
operation: "unix",
|
||||
validate: func(got string) error {
|
||||
if _, err := strconv.ParseInt(got, 10, 64); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "today returns YYYY-MM-DD",
|
||||
operation: "today",
|
||||
validate: func(got string) error {
|
||||
if _, err := time.Parse("2006-01-02", got); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "full returns long date",
|
||||
operation: "full",
|
||||
validate: func(got string) error {
|
||||
if !strings.Contains(got, now.Month().String()) {
|
||||
return fmt.Errorf("full date missing month name")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "relative positive hours",
|
||||
operation: "rel",
|
||||
value: "2h",
|
||||
validate: func(got string) error {
|
||||
t, err := time.Parse(time.RFC3339, got)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
expected := now.Add(2 * time.Hour)
|
||||
if t.Hour() != expected.Hour() {
|
||||
return fmt.Errorf("expected hour %d, got %d", expected.Hour(), t.Hour())
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "relative negative days",
|
||||
operation: "rel",
|
||||
value: "-2d",
|
||||
validate: func(got string) error {
|
||||
t, err := time.Parse("2006-01-02", got)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
expected := now.AddDate(0, 0, -2)
|
||||
if t.Day() != expected.Day() {
|
||||
return fmt.Errorf("expected day %d, got %d", expected.Day(), t.Day())
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
// Error cases
|
||||
{
|
||||
name: "invalid operation",
|
||||
operation: "invalid",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "empty relative value",
|
||||
operation: "rel",
|
||||
value: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "invalid relative format",
|
||||
operation: "rel",
|
||||
value: "2x",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
plugin := &DateTimePlugin{}
|
||||
now := time.Now()
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("DateTimePlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if err == nil && tt.validate != nil {
|
||||
if err := tt.validate(got); err != nil {
|
||||
t.Errorf("DateTimePlugin.Apply() validation failed: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
validate func(string) error
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "now returns RFC3339",
|
||||
operation: "now",
|
||||
validate: func(got string) error {
|
||||
if _, err := time.Parse(time.RFC3339, got); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "time returns HH:MM:SS",
|
||||
operation: "time",
|
||||
validate: func(got string) error {
|
||||
if _, err := time.Parse("15:04:05", got); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "unix returns timestamp",
|
||||
operation: "unix",
|
||||
validate: func(got string) error {
|
||||
if _, err := strconv.ParseInt(got, 10, 64); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "today returns YYYY-MM-DD",
|
||||
operation: "today",
|
||||
validate: func(got string) error {
|
||||
if _, err := time.Parse("2006-01-02", got); err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "full returns long date",
|
||||
operation: "full",
|
||||
validate: func(got string) error {
|
||||
if !strings.Contains(got, now.Month().String()) {
|
||||
return fmt.Errorf("full date missing month name")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "relative positive hours",
|
||||
operation: "rel",
|
||||
value: "2h",
|
||||
validate: func(got string) error {
|
||||
t, err := time.Parse(time.RFC3339, got)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
expected := now.Add(2 * time.Hour)
|
||||
if t.Hour() != expected.Hour() {
|
||||
return fmt.Errorf("expected hour %d, got %d", expected.Hour(), t.Hour())
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "relative negative days",
|
||||
operation: "rel",
|
||||
value: "-2d",
|
||||
validate: func(got string) error {
|
||||
t, err := time.Parse("2006-01-02", got)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
expected := now.AddDate(0, 0, -2)
|
||||
if t.Day() != expected.Day() {
|
||||
return fmt.Errorf("expected day %d, got %d", expected.Day(), t.Day())
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
// Error cases
|
||||
{
|
||||
name: "invalid operation",
|
||||
operation: "invalid",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "empty relative value",
|
||||
operation: "rel",
|
||||
value: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "invalid relative format",
|
||||
operation: "rel",
|
||||
value: "2x",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("DateTimePlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if err == nil && tt.validate != nil {
|
||||
if err := tt.validate(got); err != nil {
|
||||
t.Errorf("DateTimePlugin.Apply() validation failed: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
196
plugins/template/extension_executor.go
Normal file
196
plugins/template/extension_executor.go
Normal file
@@ -0,0 +1,196 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// ExtensionExecutor handles the secure execution of extensions
|
||||
// It uses the registry to verify extensions before running them
|
||||
type ExtensionExecutor struct {
|
||||
registry *ExtensionRegistry
|
||||
}
|
||||
|
||||
// NewExtensionExecutor creates a new executor instance
|
||||
// It requires a registry to verify extensions
|
||||
func NewExtensionExecutor(registry *ExtensionRegistry) *ExtensionExecutor {
|
||||
return &ExtensionExecutor{
|
||||
registry: registry,
|
||||
}
|
||||
}
|
||||
|
||||
// Execute runs an extension with the given operation and value string
|
||||
// name: the registered name of the extension
|
||||
// operation: the operation to perform
|
||||
// value: the input value(s) for the operation
|
||||
// In extension_executor.go
|
||||
func (e *ExtensionExecutor) Execute(name, operation, value string) (string, error) {
|
||||
// Get and verify extension from registry
|
||||
ext, err := e.registry.GetExtension(name)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get extension: %w", err)
|
||||
}
|
||||
|
||||
// Format the command using our template system
|
||||
cmdStr, err := e.formatCommand(ext, operation, value)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to format command: %w", err)
|
||||
}
|
||||
|
||||
// Split the command string into command and arguments
|
||||
cmdParts := strings.Fields(cmdStr)
|
||||
if len(cmdParts) < 1 {
|
||||
return "", fmt.Errorf("empty command after formatting")
|
||||
}
|
||||
|
||||
// Create command with the Executable and formatted arguments
|
||||
cmd := exec.Command("sh", "-c", cmdStr)
|
||||
//cmd := exec.Command(cmdParts[0], cmdParts[1:]...)
|
||||
|
||||
// Set up environment if specified
|
||||
if len(ext.Env) > 0 {
|
||||
cmd.Env = append(os.Environ(), ext.Env...)
|
||||
}
|
||||
|
||||
// Execute based on output method
|
||||
outputMethod := ext.GetOutputMethod()
|
||||
if outputMethod == "file" {
|
||||
return e.executeWithFile(cmd, ext)
|
||||
}
|
||||
return e.executeStdout(cmd, ext)
|
||||
}
|
||||
|
||||
// formatCommand uses fabric's template system to format the command
|
||||
// It creates a variables map for the template system using the input values
|
||||
func (e *ExtensionExecutor) formatCommand(ext *ExtensionDefinition, operation string, value string) (string, error) {
|
||||
// Get operation config
|
||||
opConfig, exists := ext.Operations[operation]
|
||||
if !exists {
|
||||
return "", fmt.Errorf("operation %s not found for extension %s", operation, ext.Name)
|
||||
}
|
||||
|
||||
vars := make(map[string]string)
|
||||
vars["executable"] = ext.Executable
|
||||
vars["operation"] = operation
|
||||
vars["value"] = value
|
||||
|
||||
// Split on pipe for numbered variables
|
||||
values := strings.Split(value, "|")
|
||||
for i, val := range values {
|
||||
vars[fmt.Sprintf("%d", i+1)] = val
|
||||
}
|
||||
|
||||
return ApplyTemplate(opConfig.CmdTemplate, vars, "")
|
||||
}
|
||||
|
||||
// executeStdout runs the command and captures its stdout
|
||||
func (e *ExtensionExecutor) executeStdout(cmd *exec.Cmd, ext *ExtensionDefinition) (string, error) {
|
||||
var stdout bytes.Buffer
|
||||
var stderr bytes.Buffer
|
||||
cmd.Stdout = &stdout
|
||||
cmd.Stderr = &stderr
|
||||
|
||||
//debug output
|
||||
fmt.Printf("Executing command: %s\n", cmd.String())
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
return "", fmt.Errorf("execution failed: %w\nstderr: %s", err, stderr.String())
|
||||
}
|
||||
|
||||
return stdout.String(), nil
|
||||
}
|
||||
|
||||
// executeWithFile runs the command and handles file-based output
|
||||
func (e *ExtensionExecutor) executeWithFile(cmd *exec.Cmd, ext *ExtensionDefinition) (string, error) {
|
||||
// Parse timeout - this is now a first-class field
|
||||
timeout, err := time.ParseDuration(ext.Timeout)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("invalid timeout format: %w", err)
|
||||
}
|
||||
|
||||
// Create context with timeout
|
||||
ctx, cancel := context.WithTimeout(context.Background(), timeout)
|
||||
defer cancel()
|
||||
cmd = exec.CommandContext(ctx, cmd.Path, cmd.Args[1:]...)
|
||||
cmd.Env = cmd.Env
|
||||
|
||||
fileConfig := ext.GetFileConfig()
|
||||
if fileConfig == nil {
|
||||
return "", fmt.Errorf("no file configuration found")
|
||||
}
|
||||
|
||||
// Handle path from stdout case
|
||||
if pathFromStdout, ok := fileConfig["path_from_stdout"].(bool); ok && pathFromStdout {
|
||||
return e.handlePathFromStdout(cmd, ext)
|
||||
}
|
||||
|
||||
// Handle fixed file case
|
||||
workDir, _ := fileConfig["work_dir"].(string)
|
||||
outputFile, _ := fileConfig["output_file"].(string)
|
||||
|
||||
if outputFile == "" {
|
||||
return "", fmt.Errorf("no output file specified in configuration")
|
||||
}
|
||||
|
||||
// Set working directory if specified
|
||||
if workDir != "" {
|
||||
cmd.Dir = workDir
|
||||
}
|
||||
|
||||
var stderr bytes.Buffer
|
||||
cmd.Stderr = &stderr
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
if ctx.Err() == context.DeadlineExceeded {
|
||||
return "", fmt.Errorf("execution timed out after %v", timeout)
|
||||
}
|
||||
return "", fmt.Errorf("execution failed: %w\nerr: %s", err, stderr.String())
|
||||
}
|
||||
|
||||
// Construct full file path
|
||||
outputPath := outputFile
|
||||
if workDir != "" {
|
||||
outputPath = filepath.Join(workDir, outputFile)
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(outputPath)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read output file: %w", err)
|
||||
}
|
||||
|
||||
// Handle cleanup if enabled
|
||||
if ext.IsCleanupEnabled() {
|
||||
defer os.Remove(outputPath)
|
||||
}
|
||||
|
||||
return string(content), nil
|
||||
}
|
||||
|
||||
// Helper method to handle path from stdout case
|
||||
func (e *ExtensionExecutor) handlePathFromStdout(cmd *exec.Cmd, ext *ExtensionDefinition) (string, error) {
|
||||
var stdout, stderr bytes.Buffer
|
||||
cmd.Stdout = &stdout
|
||||
cmd.Stderr = &stderr
|
||||
|
||||
if err := cmd.Run(); err != nil {
|
||||
return "", fmt.Errorf("failed to get output path: %w\nerr: %s", err, stderr.String())
|
||||
}
|
||||
|
||||
outputPath := strings.TrimSpace(stdout.String())
|
||||
content, err := os.ReadFile(outputPath)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read output file: %w", err)
|
||||
}
|
||||
|
||||
if ext.IsCleanupEnabled() {
|
||||
defer os.Remove(outputPath)
|
||||
}
|
||||
|
||||
return string(content), nil
|
||||
}
|
||||
360
plugins/template/extension_executor_test.go
Normal file
360
plugins/template/extension_executor_test.go
Normal file
@@ -0,0 +1,360 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestExtensionExecutor(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-executor-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test script that has both stdout and file output modes
|
||||
testScript := filepath.Join(tmpDir, "test-script.sh")
|
||||
scriptContent := `#!/bin/bash
|
||||
case "$1" in
|
||||
"stdout")
|
||||
echo "Hello, $2!"
|
||||
;;
|
||||
"file")
|
||||
echo "Hello, $2!" > "$3"
|
||||
echo "$3" # Print the filename for path_from_stdout
|
||||
;;
|
||||
*)
|
||||
echo "Unknown command" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac`
|
||||
|
||||
if err := os.WriteFile(testScript, []byte(scriptContent), 0755); err != nil {
|
||||
t.Fatalf("Failed to create test script: %v", err)
|
||||
}
|
||||
|
||||
// Create registry and register our test extensions
|
||||
registry := NewExtensionRegistry(tmpDir)
|
||||
executor := NewExtensionExecutor(registry)
|
||||
|
||||
// Test stdout-based extension
|
||||
t.Run("StdoutExecution", func(t *testing.T) {
|
||||
configPath := filepath.Join(tmpDir, "stdout-extension.yaml")
|
||||
configContent := `name: stdout-test
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
greet:
|
||||
cmd_template: "{{executable}} stdout {{1}}"
|
||||
config:
|
||||
output:
|
||||
method: stdout`
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
t.Fatalf("Failed to create config: %v", err)
|
||||
}
|
||||
|
||||
if err := registry.Register(configPath); err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
output, err := executor.Execute("stdout-test", "greet", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
// Test file-based extension
|
||||
t.Run("FileExecution", func(t *testing.T) {
|
||||
configPath := filepath.Join(tmpDir, "file-extension.yaml")
|
||||
configContent := `name: file-test
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
greet:
|
||||
cmd_template: "{{executable}} file {{1}} {{2}}"
|
||||
config:
|
||||
output:
|
||||
method: file
|
||||
file_config:
|
||||
cleanup: true
|
||||
path_from_stdout: true`
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
t.Fatalf("Failed to create config: %v", err)
|
||||
}
|
||||
|
||||
if err := registry.Register(configPath); err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
output, err := executor.Execute("file-test", "greet", "World|/tmp/test.txt")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
// Test execution errors
|
||||
t.Run("ExecutionErrors", func(t *testing.T) {
|
||||
// Test with non-existent extension
|
||||
_, err := executor.Execute("nonexistent", "test", "value")
|
||||
if err == nil {
|
||||
t.Error("Expected error executing non-existent extension, got nil")
|
||||
}
|
||||
|
||||
// Test with invalid command that should exit non-zero
|
||||
configPath := filepath.Join(tmpDir, "error-extension.yaml")
|
||||
configContent := `name: error-test
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
invalid:
|
||||
cmd_template: "{{executable}} invalid {{1}}"
|
||||
config:
|
||||
output:
|
||||
method: stdout`
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
t.Fatalf("Failed to create config: %v", err)
|
||||
}
|
||||
|
||||
if err := registry.Register(configPath); err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("error-test", "invalid", "test")
|
||||
if err == nil {
|
||||
t.Error("Expected error from invalid command, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "Unknown command") {
|
||||
t.Errorf("Expected 'Unknown command' in error, got: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestFixedFileExtensionExecutor(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-executor-fixed-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test script
|
||||
testScript := filepath.Join(tmpDir, "test-script.sh")
|
||||
scriptContent := `#!/bin/bash
|
||||
case "$1" in
|
||||
"write")
|
||||
echo "Hello, $2!" > "$3"
|
||||
;;
|
||||
"append")
|
||||
echo "Hello, $2!" >> "$3"
|
||||
;;
|
||||
"large")
|
||||
for i in {1..1000}; do
|
||||
echo "Line $i" >> "$3"
|
||||
done
|
||||
;;
|
||||
"error")
|
||||
echo "Error message" >&2
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
echo "Unknown command" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac`
|
||||
|
||||
if err := os.WriteFile(testScript, []byte(scriptContent), 0755); err != nil {
|
||||
t.Fatalf("Failed to create test script: %v", err)
|
||||
}
|
||||
|
||||
registry := NewExtensionRegistry(tmpDir)
|
||||
executor := NewExtensionExecutor(registry)
|
||||
|
||||
// Helper function to create and register extension
|
||||
createExtension := func(name, opName, cmdTemplate string, config map[string]interface{}) error {
|
||||
configPath := filepath.Join(tmpDir, name+".yaml")
|
||||
configContent := `name: ` + name + `
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
` + opName + `:
|
||||
cmd_template: "` + cmdTemplate + `"
|
||||
config:
|
||||
output:
|
||||
method: file
|
||||
file_config:`
|
||||
|
||||
// Add config options
|
||||
for k, v := range config {
|
||||
configContent += "\n " + k + ": " + strings.TrimSpace(v.(string))
|
||||
}
|
||||
|
||||
if err := os.WriteFile(configPath, []byte(configContent), 0644); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return registry.Register(configPath)
|
||||
}
|
||||
|
||||
// Test basic fixed file output
|
||||
t.Run("BasicFixedFile", func(t *testing.T) {
|
||||
outputFile := filepath.Join(tmpDir, "output.txt")
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"output.txt"`,
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("basic-test", "write",
|
||||
"{{executable}} write {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
output, err := executor.Execute("basic-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
// Test no work_dir specified
|
||||
t.Run("NoWorkDir", func(t *testing.T) {
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"direct-output.txt"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("no-workdir-test", "write",
|
||||
"{{executable}} write {{1}} direct-output.txt", config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("no-workdir-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
// Test cleanup behavior
|
||||
t.Run("CleanupBehavior", func(t *testing.T) {
|
||||
outputFile := filepath.Join(tmpDir, "cleanup-test.txt")
|
||||
|
||||
// Test with cleanup enabled
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"cleanup-test.txt"`,
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("cleanup-test", "write",
|
||||
"{{executable}} write {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("cleanup-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
// File should be deleted after execution
|
||||
if _, err := os.Stat(outputFile); !os.IsNotExist(err) {
|
||||
t.Error("Expected output file to be cleaned up")
|
||||
}
|
||||
|
||||
// Test with cleanup disabled
|
||||
config["cleanup"] = "false"
|
||||
err = createExtension("no-cleanup-test", "write",
|
||||
"{{executable}} write {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("no-cleanup-test", "write", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to execute: %v", err)
|
||||
}
|
||||
|
||||
// File should remain after execution
|
||||
if _, err := os.Stat(outputFile); os.IsNotExist(err) {
|
||||
t.Error("Expected output file to remain")
|
||||
}
|
||||
})
|
||||
|
||||
// Test error cases
|
||||
t.Run("ErrorCases", func(t *testing.T) {
|
||||
outputFile := filepath.Join(tmpDir, "error-test.txt")
|
||||
config := map[string]interface{}{
|
||||
"output_file": `"error-test.txt"`,
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
// Test command error
|
||||
err := createExtension("error-test", "error",
|
||||
"{{executable}} error {{1}} "+outputFile, config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("error-test", "error", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error from failing command, got nil")
|
||||
}
|
||||
|
||||
// Test invalid work_dir
|
||||
config["work_dir"] = `"/nonexistent/directory"`
|
||||
err = createExtension("invalid-dir-test", "write",
|
||||
"{{executable}} write {{1}} output.txt", config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("invalid-dir-test", "write", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error from invalid work_dir, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
// Test with missing output_file
|
||||
t.Run("MissingOutputFile", func(t *testing.T) {
|
||||
config := map[string]interface{}{
|
||||
"work_dir": `"` + tmpDir + `"`,
|
||||
"cleanup": "true",
|
||||
}
|
||||
|
||||
err := createExtension("missing-output-test", "write",
|
||||
"{{executable}} write {{1}} output.txt", config)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create extension: %v", err)
|
||||
}
|
||||
|
||||
_, err = executor.Execute("missing-output-test", "write", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error from missing output_file, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
135
plugins/template/extension_manager.go
Normal file
135
plugins/template/extension_manager.go
Normal file
@@ -0,0 +1,135 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
"gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
// ExtensionManager handles the high-level operations of the extension system
|
||||
type ExtensionManager struct {
|
||||
registry *ExtensionRegistry
|
||||
executor *ExtensionExecutor
|
||||
configDir string
|
||||
}
|
||||
|
||||
// NewExtensionManager creates a new extension manager instance
|
||||
func NewExtensionManager(configDir string) *ExtensionManager {
|
||||
registry := NewExtensionRegistry(configDir)
|
||||
return &ExtensionManager{
|
||||
registry: registry,
|
||||
executor: NewExtensionExecutor(registry),
|
||||
configDir: configDir,
|
||||
}
|
||||
}
|
||||
|
||||
// ListExtensions handles the listextensions flag action
|
||||
func (em *ExtensionManager) ListExtensions() error {
|
||||
if em.registry == nil || em.registry.registry.Extensions == nil {
|
||||
return fmt.Errorf("extension registry not initialized")
|
||||
}
|
||||
|
||||
for name, entry := range em.registry.registry.Extensions {
|
||||
fmt.Printf("Extension: %s\n", name)
|
||||
|
||||
// Try to load extension details
|
||||
ext, err := em.registry.GetExtension(name)
|
||||
if err != nil {
|
||||
fmt.Printf(" Status: DISABLED - Hash verification failed: %v\n", err)
|
||||
fmt.Printf(" Config Path: %s\n\n", entry.ConfigPath)
|
||||
continue
|
||||
}
|
||||
|
||||
// Print extension details if verification succeeded
|
||||
fmt.Printf(" Status: ENABLED\n")
|
||||
fmt.Printf(" Executable: %s\n", ext.Executable)
|
||||
fmt.Printf(" Type: %s\n", ext.Type)
|
||||
fmt.Printf(" Timeout: %s\n", ext.Timeout)
|
||||
fmt.Printf(" Description: %s\n", ext.Description)
|
||||
fmt.Printf(" Version: %s\n", ext.Version)
|
||||
|
||||
fmt.Printf(" Operations:\n")
|
||||
for opName, opConfig := range ext.Operations {
|
||||
fmt.Printf(" %s:\n", opName)
|
||||
fmt.Printf(" Command Template: %s\n", opConfig.CmdTemplate)
|
||||
}
|
||||
|
||||
if fileConfig := ext.GetFileConfig(); fileConfig != nil {
|
||||
fmt.Printf(" File Configuration:\n")
|
||||
for k, v := range fileConfig {
|
||||
fmt.Printf(" %s: %v\n", k, v)
|
||||
}
|
||||
}
|
||||
fmt.Printf("\n")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// RegisterExtension handles the addextension flag action
|
||||
func (em *ExtensionManager) RegisterExtension(configPath string) error {
|
||||
absPath, err := filepath.Abs(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("invalid config path: %w", err)
|
||||
}
|
||||
|
||||
// Get extension name before registration for status message
|
||||
data, err := os.ReadFile(absPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
if err := em.registry.Register(absPath); err != nil {
|
||||
return fmt.Errorf("failed to register extension: %w", err)
|
||||
}
|
||||
|
||||
if _, err := time.ParseDuration(ext.Timeout); err != nil {
|
||||
return fmt.Errorf("invalid timeout value '%s': must be a duration like '30s' or '1m': %w", ext.Timeout, err)
|
||||
}
|
||||
|
||||
// Print success message with extension details
|
||||
fmt.Printf("Successfully registered extension:\n")
|
||||
fmt.Printf("Name: %s\n", ext.Name)
|
||||
fmt.Printf(" Executable: %s\n", ext.Executable)
|
||||
fmt.Printf(" Type: %s\n", ext.Type)
|
||||
fmt.Printf(" Timeout: %s\n", ext.Timeout)
|
||||
fmt.Printf(" Description: %s\n", ext.Description)
|
||||
fmt.Printf(" Version: %s\n", ext.Version)
|
||||
|
||||
fmt.Printf(" Operations:\n")
|
||||
for opName, opConfig := range ext.Operations {
|
||||
fmt.Printf(" %s:\n", opName)
|
||||
fmt.Printf(" Command Template: %s\n", opConfig.CmdTemplate)
|
||||
}
|
||||
|
||||
if fileConfig := ext.GetFileConfig(); fileConfig != nil {
|
||||
fmt.Printf(" File Configuration:\n")
|
||||
for k, v := range fileConfig {
|
||||
fmt.Printf(" %s: %v\n", k, v)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// RemoveExtension handles the rmextension flag action
|
||||
func (em *ExtensionManager) RemoveExtension(name string) error {
|
||||
if err := em.registry.Remove(name); err != nil {
|
||||
return fmt.Errorf("failed to remove extension: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ProcessExtension handles template processing for extension directives
|
||||
func (em *ExtensionManager) ProcessExtension(name, operation, value string) (string, error) {
|
||||
return em.executor.Execute(name, operation, value)
|
||||
}
|
||||
184
plugins/template/extension_manager_test.go
Normal file
184
plugins/template/extension_manager_test.go
Normal file
@@ -0,0 +1,184 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestExtensionManager is the main test suite for ExtensionManager
|
||||
func TestExtensionManager(t *testing.T) {
|
||||
// Create temporary directory for tests
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-test-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test extension config
|
||||
testConfig := filepath.Join(tmpDir, "test-extension.yaml")
|
||||
testScript := filepath.Join(tmpDir, "test-script.sh")
|
||||
|
||||
// Create test script
|
||||
scriptContent := `#!/bin/bash
|
||||
if [ "$1" = "echo" ]; then
|
||||
echo "Hello, $2!"
|
||||
fi`
|
||||
|
||||
err = os.WriteFile(testScript, []byte(scriptContent), 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test script: %v", err)
|
||||
}
|
||||
|
||||
// Create test config
|
||||
configContent := `name: test-extension
|
||||
executable: ` + testScript + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
description: "Test extension"
|
||||
version: "1.0.0"
|
||||
operations:
|
||||
echo:
|
||||
cmd_template: "{{executable}} echo {{1}}"
|
||||
`
|
||||
|
||||
err = os.WriteFile(testConfig, []byte(configContent), 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test config: %v", err)
|
||||
}
|
||||
|
||||
// Initialize manager
|
||||
manager := NewExtensionManager(tmpDir)
|
||||
|
||||
// Test cases
|
||||
t.Run("RegisterExtension", func(t *testing.T) {
|
||||
err := manager.RegisterExtension(testConfig)
|
||||
if err != nil {
|
||||
t.Errorf("Failed to register extension: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ListExtensions", func(t *testing.T) {
|
||||
err := manager.ListExtensions()
|
||||
if err != nil {
|
||||
t.Errorf("Failed to list extensions: %v", err)
|
||||
}
|
||||
// Note: Output validation would require capturing stdout
|
||||
})
|
||||
|
||||
t.Run("ProcessExtension", func(t *testing.T) {
|
||||
output, err := manager.ProcessExtension("test-extension", "echo", "World")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to process extension: %v", err)
|
||||
}
|
||||
expected := "Hello, World!\n"
|
||||
if output != expected {
|
||||
t.Errorf("Expected output %q, got %q", expected, output)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("RemoveExtension", func(t *testing.T) {
|
||||
err := manager.RemoveExtension("test-extension")
|
||||
if err != nil {
|
||||
t.Errorf("Failed to remove extension: %v", err)
|
||||
}
|
||||
|
||||
// Verify extension is removed by trying to process it
|
||||
_, err = manager.ProcessExtension("test-extension", "echo", "World")
|
||||
if err == nil {
|
||||
t.Error("Expected error processing removed extension, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestExtensionManagerErrors tests error cases
|
||||
func TestExtensionManagerErrors(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-test-errors-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
manager := NewExtensionManager(tmpDir)
|
||||
|
||||
t.Run("RegisterNonexistentConfig", func(t *testing.T) {
|
||||
err := manager.RegisterExtension("/nonexistent/config.yaml")
|
||||
if err == nil {
|
||||
t.Error("Expected error registering nonexistent config, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ProcessNonexistentExtension", func(t *testing.T) {
|
||||
_, err := manager.ProcessExtension("nonexistent", "echo", "test")
|
||||
if err == nil {
|
||||
t.Error("Expected error processing nonexistent extension, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("RemoveNonexistentExtension", func(t *testing.T) {
|
||||
err := manager.RemoveExtension("nonexistent")
|
||||
if err == nil {
|
||||
t.Error("Expected error removing nonexistent extension, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestExtensionManagerWithInvalidConfig tests handling of invalid configurations
|
||||
func TestExtensionManagerWithInvalidConfig(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-test-invalid-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
invalidConfig := filepath.Join(tmpDir, "invalid-extension.yaml")
|
||||
|
||||
// Test cases with different invalid configurations
|
||||
testCases := []struct {
|
||||
name string
|
||||
config string
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "MissingExecutable",
|
||||
config: `name: invalid-extension
|
||||
type: executable
|
||||
timeout: 30s`,
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "InvalidTimeout",
|
||||
config: `name: invalid-extension
|
||||
executable: /bin/echo
|
||||
type: executable
|
||||
timeout: invalid`,
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "EmptyName",
|
||||
config: `name: ""
|
||||
executable: /bin/echo
|
||||
type: executable
|
||||
timeout: 30s`,
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
manager := NewExtensionManager(tmpDir)
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
err := os.WriteFile(invalidConfig, []byte(tc.config), 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create invalid config file: %v", err)
|
||||
}
|
||||
|
||||
err = manager.RegisterExtension(invalidConfig)
|
||||
if tc.wantErr && err == nil {
|
||||
t.Error("Expected error registering invalid config, got nil")
|
||||
} else if !tc.wantErr && err != nil {
|
||||
t.Errorf("Unexpected error registering config: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
329
plugins/template/extension_registry.go
Normal file
329
plugins/template/extension_registry.go
Normal file
@@ -0,0 +1,329 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gopkg.in/yaml.v3"
|
||||
// Add this import
|
||||
)
|
||||
|
||||
// ExtensionDefinition represents a single extension configuration
|
||||
type ExtensionDefinition struct {
|
||||
// Global properties
|
||||
Name string `yaml:"name"`
|
||||
Executable string `yaml:"executable"`
|
||||
Type string `yaml:"type"`
|
||||
Timeout string `yaml:"timeout"`
|
||||
Description string `yaml:"description"`
|
||||
Version string `yaml:"version"`
|
||||
Env []string `yaml:"env"`
|
||||
|
||||
// Operation-specific commands
|
||||
Operations map[string]OperationConfig `yaml:"operations"`
|
||||
|
||||
// Additional config
|
||||
Config map[string]interface{} `yaml:"config"`
|
||||
}
|
||||
|
||||
type OperationConfig struct {
|
||||
CmdTemplate string `yaml:"cmd_template"`
|
||||
}
|
||||
|
||||
// RegistryEntry represents a registered extension
|
||||
type RegistryEntry struct {
|
||||
ConfigPath string `yaml:"config_path"`
|
||||
ConfigHash string `yaml:"config_hash"`
|
||||
ExecutableHash string `yaml:"executable_hash"`
|
||||
}
|
||||
|
||||
type ExtensionRegistry struct {
|
||||
configDir string
|
||||
registry struct {
|
||||
Extensions map[string]*RegistryEntry `yaml:"extensions"`
|
||||
}
|
||||
}
|
||||
|
||||
// Helper methods for Config access
|
||||
func (e *ExtensionDefinition) GetOutputMethod() string {
|
||||
if output, ok := e.Config["output"].(map[string]interface{}); ok {
|
||||
if method, ok := output["method"].(string); ok {
|
||||
return method
|
||||
}
|
||||
}
|
||||
return "stdout" // default to stdout if not specified
|
||||
}
|
||||
|
||||
func (e *ExtensionDefinition) GetFileConfig() map[string]interface{} {
|
||||
if output, ok := e.Config["output"].(map[string]interface{}); ok {
|
||||
if fileConfig, ok := output["file_config"].(map[string]interface{}); ok {
|
||||
return fileConfig
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (e *ExtensionDefinition) IsCleanupEnabled() bool {
|
||||
if fc := e.GetFileConfig(); fc != nil {
|
||||
if cleanup, ok := fc["cleanup"].(bool); ok {
|
||||
return cleanup
|
||||
}
|
||||
}
|
||||
return false // default to no cleanup
|
||||
}
|
||||
|
||||
func NewExtensionRegistry(configDir string) *ExtensionRegistry {
|
||||
r := &ExtensionRegistry{
|
||||
configDir: configDir,
|
||||
}
|
||||
r.registry.Extensions = make(map[string]*RegistryEntry)
|
||||
|
||||
r.ensureConfigDir()
|
||||
|
||||
if err := r.loadRegistry(); err != nil {
|
||||
if Debug {
|
||||
fmt.Printf("Warning: could not load extension registry: %v\n", err)
|
||||
}
|
||||
}
|
||||
|
||||
return r
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) ensureConfigDir() error {
|
||||
extDir := filepath.Join(r.configDir, "extensions")
|
||||
return os.MkdirAll(extDir, 0755)
|
||||
}
|
||||
|
||||
// Update the Register method in extension_registry.go
|
||||
|
||||
func (r *ExtensionRegistry) Register(configPath string) error {
|
||||
// Read and parse the extension definition to verify it
|
||||
data, err := os.ReadFile(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
// Validate extension name
|
||||
if ext.Name == "" {
|
||||
return fmt.Errorf("extension name cannot be empty")
|
||||
}
|
||||
|
||||
if strings.Contains(ext.Name, " ") {
|
||||
return fmt.Errorf("extension name '%s' contains spaces - names must not contain spaces", ext.Name)
|
||||
}
|
||||
|
||||
// Verify executable exists
|
||||
if _, err := os.Stat(ext.Executable); err != nil {
|
||||
return fmt.Errorf("executable not found: %w", err)
|
||||
}
|
||||
|
||||
// Get absolute path to config
|
||||
absPath, err := filepath.Abs(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get absolute path: %w", err)
|
||||
}
|
||||
|
||||
// Calculate hashes
|
||||
configHash := ComputeStringHash(string(data))
|
||||
executableHash, err := ComputeHash(ext.Executable)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to hash executable: %w", err)
|
||||
}
|
||||
|
||||
// Store entry
|
||||
r.registry.Extensions[ext.Name] = &RegistryEntry{
|
||||
ConfigPath: absPath,
|
||||
ConfigHash: configHash,
|
||||
ExecutableHash: executableHash,
|
||||
}
|
||||
|
||||
return r.saveRegistry()
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) validateExtensionDefinition(ext *ExtensionDefinition) error {
|
||||
// Validate required fields
|
||||
if ext.Name == "" {
|
||||
return fmt.Errorf("extension name is required")
|
||||
}
|
||||
if ext.Executable == "" {
|
||||
return fmt.Errorf("executable path is required")
|
||||
}
|
||||
if ext.Type == "" {
|
||||
return fmt.Errorf("extension type is required")
|
||||
}
|
||||
|
||||
// Validate timeout format
|
||||
if ext.Timeout != "" {
|
||||
if _, err := time.ParseDuration(ext.Timeout); err != nil {
|
||||
return fmt.Errorf("invalid timeout format: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Validate operations
|
||||
if len(ext.Operations) == 0 {
|
||||
return fmt.Errorf("at least one operation must be defined")
|
||||
}
|
||||
for name, op := range ext.Operations {
|
||||
if op.CmdTemplate == "" {
|
||||
return fmt.Errorf("command template is required for operation %s", name)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) Remove(name string) error {
|
||||
if _, exists := r.registry.Extensions[name]; !exists {
|
||||
return fmt.Errorf("extension %s not found", name)
|
||||
}
|
||||
|
||||
delete(r.registry.Extensions, name)
|
||||
|
||||
return r.saveRegistry()
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) Verify(name string) error {
|
||||
// Get the registry entry
|
||||
entry, exists := r.registry.Extensions[name]
|
||||
if !exists {
|
||||
return fmt.Errorf("extension %s not found", name)
|
||||
}
|
||||
|
||||
// Load and parse the config file
|
||||
data, err := os.ReadFile(entry.ConfigPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify config hash
|
||||
currentConfigHash := ComputeStringHash(string(data))
|
||||
if currentConfigHash != entry.ConfigHash {
|
||||
return fmt.Errorf("config file hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
// Parse to get executable path
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify executable hash
|
||||
currentExecutableHash, err := ComputeHash(ext.Executable)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to verify executable: %w", err)
|
||||
}
|
||||
|
||||
if currentExecutableHash != entry.ExecutableHash {
|
||||
return fmt.Errorf("executable hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) GetExtension(name string) (*ExtensionDefinition, error) {
|
||||
entry, exists := r.registry.Extensions[name]
|
||||
if !exists {
|
||||
return nil, fmt.Errorf("extension %s not found", name)
|
||||
}
|
||||
|
||||
// Read current config file
|
||||
data, err := os.ReadFile(entry.ConfigPath)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify config hash
|
||||
currentHash := ComputeStringHash(string(data))
|
||||
if currentHash != entry.ConfigHash {
|
||||
return nil, fmt.Errorf("config file hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
// Parse config
|
||||
var ext ExtensionDefinition
|
||||
if err := yaml.Unmarshal(data, &ext); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse config file: %w", err)
|
||||
}
|
||||
|
||||
// Verify executable hash
|
||||
currentExecHash, err := ComputeHash(ext.Executable)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to verify executable: %w", err)
|
||||
}
|
||||
|
||||
if currentExecHash != entry.ExecutableHash {
|
||||
return nil, fmt.Errorf("executable hash mismatch for %s", name)
|
||||
}
|
||||
|
||||
return &ext, nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) ListExtensions() ([]*ExtensionDefinition, error) {
|
||||
var exts []*ExtensionDefinition
|
||||
|
||||
for name := range r.registry.Extensions {
|
||||
ext, err := r.GetExtension(name)
|
||||
if err != nil {
|
||||
// Instead of failing, we'll return nil for this extension
|
||||
// The manager will handle displaying the error
|
||||
exts = append(exts, nil)
|
||||
continue
|
||||
}
|
||||
exts = append(exts, ext)
|
||||
}
|
||||
|
||||
return exts, nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) calculateFileHash(path string) (string, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
h := sha256.New()
|
||||
if _, err := io.Copy(h, f); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return hex.EncodeToString(h.Sum(nil)), nil
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) saveRegistry() error {
|
||||
data, err := yaml.Marshal(r.registry)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to marshal extension registry: %w", err)
|
||||
}
|
||||
|
||||
registryPath := filepath.Join(r.configDir, "extensions", "extensions.yaml")
|
||||
return os.WriteFile(registryPath, data, 0644)
|
||||
}
|
||||
|
||||
func (r *ExtensionRegistry) loadRegistry() error {
|
||||
registryPath := filepath.Join(r.configDir, "extensions", "extensions.yaml")
|
||||
data, err := os.ReadFile(registryPath)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil // New registry
|
||||
}
|
||||
return fmt.Errorf("failed to read extension registry: %w", err)
|
||||
}
|
||||
|
||||
// Need to unmarshal the data into our registry
|
||||
if err := yaml.Unmarshal(data, &r.registry); err != nil {
|
||||
return fmt.Errorf("failed to parse extension registry: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
75
plugins/template/extension_registry_test.go
Normal file
75
plugins/template/extension_registry_test.go
Normal file
@@ -0,0 +1,75 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestRegistryPersistence(t *testing.T) {
|
||||
tmpDir, err := os.MkdirTemp("", "fabric-ext-registry-persist-*")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDir)
|
||||
|
||||
// Create test executable
|
||||
execPath := filepath.Join(tmpDir, "test-exec.sh")
|
||||
execContent := []byte("#!/bin/bash\necho \"test\"")
|
||||
err = os.WriteFile(execPath, execContent, 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test executable: %v", err)
|
||||
}
|
||||
|
||||
// Create valid config
|
||||
configContent := `name: test-extension
|
||||
executable: ` + execPath + `
|
||||
type: executable
|
||||
timeout: 30s
|
||||
operations:
|
||||
test:
|
||||
cmd_template: "{{executable}} {{operation}}"`
|
||||
|
||||
configPath := filepath.Join(tmpDir, "test-extension.yaml")
|
||||
err = os.WriteFile(configPath, []byte(configContent), 0644)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create test config: %v", err)
|
||||
}
|
||||
|
||||
// Test registry persistence
|
||||
t.Run("SaveAndReload", func(t *testing.T) {
|
||||
// Create and populate first registry
|
||||
registry1 := NewExtensionRegistry(tmpDir)
|
||||
err := registry1.Register(configPath)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to register extension: %v", err)
|
||||
}
|
||||
|
||||
// Create new registry instance and verify it loads the saved state
|
||||
registry2 := NewExtensionRegistry(tmpDir)
|
||||
ext, err := registry2.GetExtension("test-extension")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get extension from reloaded registry: %v", err)
|
||||
}
|
||||
if ext.Name != "test-extension" {
|
||||
t.Errorf("Expected extension name 'test-extension', got %q", ext.Name)
|
||||
}
|
||||
})
|
||||
|
||||
// Test hash verification
|
||||
t.Run("HashVerification", func(t *testing.T) {
|
||||
registry := NewExtensionRegistry(tmpDir)
|
||||
|
||||
// Modify executable after registration
|
||||
modifiedExecContent := []byte("#!/bin/bash\necho \"modified\"")
|
||||
err := os.WriteFile(execPath, modifiedExecContent, 0755)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to modify executable: %v", err)
|
||||
}
|
||||
|
||||
_, err = registry.GetExtension("test-extension")
|
||||
if err == nil {
|
||||
t.Error("Expected error when executable modified, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -14,11 +14,11 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
// MaxContentSize limits response size to 1MB to prevent memory issues
|
||||
MaxContentSize = 1024 * 1024
|
||||
|
||||
// UserAgent identifies the client in HTTP requests
|
||||
UserAgent = "Fabric-Fetch/1.0"
|
||||
// MaxContentSize limits response size to 1MB to prevent memory issues
|
||||
MaxContentSize = 1024 * 1024
|
||||
|
||||
// UserAgent identifies the client in HTTP requests
|
||||
UserAgent = "Fabric-Fetch/1.0"
|
||||
)
|
||||
|
||||
// FetchPlugin provides HTTP fetching capabilities with safety constraints:
|
||||
@@ -31,104 +31,104 @@ type FetchPlugin struct{}
|
||||
// Apply executes fetch operations:
|
||||
// - get:URL: Fetches content from URL, returns text content
|
||||
func (p *FetchPlugin) Apply(operation string, value string) (string, error) {
|
||||
debugf("Fetch: operation=%q value=%q", operation, value)
|
||||
|
||||
switch operation {
|
||||
case "get":
|
||||
return p.fetch(value)
|
||||
default:
|
||||
return "", fmt.Errorf("fetch: unknown operation %q (supported: get)", operation)
|
||||
}
|
||||
debugf("Fetch: operation=%q value=%q", operation, value)
|
||||
|
||||
switch operation {
|
||||
case "get":
|
||||
return p.fetch(value)
|
||||
default:
|
||||
return "", fmt.Errorf("fetch: unknown operation %q (supported: get)", operation)
|
||||
}
|
||||
}
|
||||
|
||||
// isTextContent checks if the content type is text-based
|
||||
func (p *FetchPlugin) isTextContent(contentType string) bool {
|
||||
debugf("Fetch: checking content type %q", contentType)
|
||||
|
||||
mediaType, _, err := mime.ParseMediaType(contentType)
|
||||
if err != nil {
|
||||
debugf("Fetch: error parsing media type: %v", err)
|
||||
return false
|
||||
}
|
||||
|
||||
isText := strings.HasPrefix(mediaType, "text/") ||
|
||||
mediaType == "application/json" ||
|
||||
mediaType == "application/xml" ||
|
||||
mediaType == "application/yaml" ||
|
||||
mediaType == "application/x-yaml" ||
|
||||
strings.HasSuffix(mediaType, "+json") ||
|
||||
strings.HasSuffix(mediaType, "+xml") ||
|
||||
strings.HasSuffix(mediaType, "+yaml")
|
||||
|
||||
debugf("Fetch: content type %q is text: %v", mediaType, isText)
|
||||
return isText
|
||||
debugf("Fetch: checking content type %q", contentType)
|
||||
|
||||
mediaType, _, err := mime.ParseMediaType(contentType)
|
||||
if err != nil {
|
||||
debugf("Fetch: error parsing media type: %v", err)
|
||||
return false
|
||||
}
|
||||
|
||||
isText := strings.HasPrefix(mediaType, "text/") ||
|
||||
mediaType == "application/json" ||
|
||||
mediaType == "application/xml" ||
|
||||
mediaType == "application/yaml" ||
|
||||
mediaType == "application/x-yaml" ||
|
||||
strings.HasSuffix(mediaType, "+json") ||
|
||||
strings.HasSuffix(mediaType, "+xml") ||
|
||||
strings.HasSuffix(mediaType, "+yaml")
|
||||
|
||||
debugf("Fetch: content type %q is text: %v", mediaType, isText)
|
||||
return isText
|
||||
}
|
||||
|
||||
// validateTextContent ensures content is valid UTF-8 without null bytes
|
||||
func (p *FetchPlugin) validateTextContent(content []byte) error {
|
||||
debugf("Fetch: validating content length=%d bytes", len(content))
|
||||
|
||||
if !utf8.Valid(content) {
|
||||
return fmt.Errorf("fetch: content is not valid UTF-8 text")
|
||||
}
|
||||
|
||||
if bytes.Contains(content, []byte{0}) {
|
||||
return fmt.Errorf("fetch: content contains null bytes")
|
||||
}
|
||||
|
||||
debugf("Fetch: content validation successful")
|
||||
return nil
|
||||
debugf("Fetch: validating content length=%d bytes", len(content))
|
||||
|
||||
if !utf8.Valid(content) {
|
||||
return fmt.Errorf("fetch: content is not valid UTF-8 text")
|
||||
}
|
||||
|
||||
if bytes.Contains(content, []byte{0}) {
|
||||
return fmt.Errorf("fetch: content contains null bytes")
|
||||
}
|
||||
|
||||
debugf("Fetch: content validation successful")
|
||||
return nil
|
||||
}
|
||||
|
||||
// fetch retrieves content from a URL with safety checks
|
||||
func (p *FetchPlugin) fetch(urlStr string) (string, error) {
|
||||
debugf("Fetch: requesting URL %q", urlStr)
|
||||
|
||||
client := &http.Client{}
|
||||
req, err := http.NewRequest("GET", urlStr, nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("fetch: error creating request: %v", err)
|
||||
}
|
||||
req.Header.Set("User-Agent", UserAgent)
|
||||
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("fetch: error fetching URL: %v", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
debugf("Fetch: got response status=%q", resp.Status)
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("fetch: HTTP error: %d - %s", resp.StatusCode, resp.Status)
|
||||
}
|
||||
debugf("Fetch: requesting URL %q", urlStr)
|
||||
|
||||
if contentLength := resp.ContentLength; contentLength > MaxContentSize {
|
||||
return "", fmt.Errorf("fetch: content too large: %d bytes (max %d bytes)",
|
||||
contentLength, MaxContentSize)
|
||||
}
|
||||
|
||||
contentType := resp.Header.Get("Content-Type")
|
||||
debugf("Fetch: content-type=%q", contentType)
|
||||
if !p.isTextContent(contentType) {
|
||||
return "", fmt.Errorf("fetch: unsupported content type %q - only text content allowed",
|
||||
contentType)
|
||||
}
|
||||
client := &http.Client{}
|
||||
req, err := http.NewRequest("GET", urlStr, nil)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("fetch: error creating request: %v", err)
|
||||
}
|
||||
req.Header.Set("User-Agent", UserAgent)
|
||||
|
||||
debugf("Fetch: reading response body")
|
||||
limitReader := io.LimitReader(resp.Body, MaxContentSize+1)
|
||||
content, err := io.ReadAll(limitReader)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("fetch: error reading response: %v", err)
|
||||
}
|
||||
|
||||
if len(content) > MaxContentSize {
|
||||
return "", fmt.Errorf("fetch: content too large: exceeds %d bytes", MaxContentSize)
|
||||
}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("fetch: error fetching URL: %v", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if err := p.validateTextContent(content); err != nil {
|
||||
return "", err
|
||||
}
|
||||
debugf("Fetch: got response status=%q", resp.Status)
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return "", fmt.Errorf("fetch: HTTP error: %d - %s", resp.StatusCode, resp.Status)
|
||||
}
|
||||
|
||||
debugf("Fetch: operation completed successfully, read %d bytes", len(content))
|
||||
return string(content), nil
|
||||
}
|
||||
if contentLength := resp.ContentLength; contentLength > MaxContentSize {
|
||||
return "", fmt.Errorf("fetch: content too large: %d bytes (max %d bytes)",
|
||||
contentLength, MaxContentSize)
|
||||
}
|
||||
|
||||
contentType := resp.Header.Get("Content-Type")
|
||||
debugf("Fetch: content-type=%q", contentType)
|
||||
if !p.isTextContent(contentType) {
|
||||
return "", fmt.Errorf("fetch: unsupported content type %q - only text content allowed",
|
||||
contentType)
|
||||
}
|
||||
|
||||
debugf("Fetch: reading response body")
|
||||
limitReader := io.LimitReader(resp.Body, MaxContentSize+1)
|
||||
content, err := io.ReadAll(limitReader)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("fetch: error reading response: %v", err)
|
||||
}
|
||||
|
||||
if len(content) > MaxContentSize {
|
||||
return "", fmt.Errorf("fetch: content too large: exceeds %d bytes", MaxContentSize)
|
||||
}
|
||||
|
||||
if err := p.validateTextContent(content); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
debugf("Fetch: operation completed successfully, read %d bytes", len(content))
|
||||
return string(content), nil
|
||||
}
|
||||
|
||||
@@ -5,67 +5,68 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestFetchPlugin(t *testing.T) {
|
||||
plugin := &FetchPlugin{}
|
||||
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
server func() *httptest.Server
|
||||
wantErr bool
|
||||
errContains string
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
server func() *httptest.Server
|
||||
wantErr bool
|
||||
errContains string
|
||||
}{
|
||||
// ... keep existing valid test cases ...
|
||||
|
||||
{
|
||||
name: "invalid URL",
|
||||
operation: "get",
|
||||
value: "not-a-url",
|
||||
wantErr: true,
|
||||
errContains: "unsupported protocol", // Updated to match actual error
|
||||
},
|
||||
{
|
||||
name: "malformed URL",
|
||||
operation: "get",
|
||||
value: "http://[::1]:namedport",
|
||||
wantErr: true,
|
||||
errContains: "error creating request",
|
||||
},
|
||||
// ... keep other test cases ...
|
||||
// ... keep existing valid test cases ...
|
||||
|
||||
{
|
||||
name: "invalid URL",
|
||||
operation: "get",
|
||||
value: "not-a-url",
|
||||
wantErr: true,
|
||||
errContains: "unsupported protocol", // Updated to match actual error
|
||||
},
|
||||
{
|
||||
name: "malformed URL",
|
||||
operation: "get",
|
||||
value: "http://[::1]:namedport",
|
||||
wantErr: true,
|
||||
errContains: "error creating request",
|
||||
},
|
||||
// ... keep other test cases ...
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var url string
|
||||
if tt.server != nil {
|
||||
server := tt.server()
|
||||
defer server.Close()
|
||||
url = server.URL
|
||||
} else {
|
||||
url = tt.value
|
||||
}
|
||||
|
||||
got, err := plugin.Apply(tt.operation, url)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("FetchPlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil && tt.errContains != "" {
|
||||
if !strings.Contains(err.Error(), tt.errContains) {
|
||||
t.Errorf("error %q should contain %q", err.Error(), tt.errContains)
|
||||
t.Logf("Full error: %v", err) // Added for better debugging
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// For successful cases, verify we got some content
|
||||
if err == nil && got == "" {
|
||||
t.Error("FetchPlugin.Apply() returned empty content on success")
|
||||
}
|
||||
})
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var url string
|
||||
if tt.server != nil {
|
||||
server := tt.server()
|
||||
defer server.Close()
|
||||
url = server.URL
|
||||
} else {
|
||||
url = tt.value
|
||||
}
|
||||
|
||||
got, err := plugin.Apply(tt.operation, url)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("FetchPlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil && tt.errContains != "" {
|
||||
if !strings.Contains(err.Error(), tt.errContains) {
|
||||
t.Errorf("error %q should contain %q", err.Error(), tt.errContains)
|
||||
t.Logf("Full error: %v", err) // Added for better debugging
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// For successful cases, verify we got some content
|
||||
if err == nil && got == "" {
|
||||
t.Error("FetchPlugin.Apply() returned empty content on success")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -24,26 +24,26 @@ type FilePlugin struct{}
|
||||
|
||||
// safePath validates and normalizes file paths
|
||||
func (p *FilePlugin) safePath(path string) (string, error) {
|
||||
debugf("File: validating path %q", path)
|
||||
|
||||
// Basic security check - no path traversal
|
||||
if strings.Contains(path, "..") {
|
||||
return "", fmt.Errorf("file: path cannot contain '..'")
|
||||
}
|
||||
|
||||
// Expand home directory if needed
|
||||
if strings.HasPrefix(path, "~/") {
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not expand home directory: %v", err)
|
||||
}
|
||||
path = filepath.Join(home, path[2:])
|
||||
}
|
||||
|
||||
// Clean the path
|
||||
cleaned := filepath.Clean(path)
|
||||
debugf("File: cleaned path %q", cleaned)
|
||||
return cleaned, nil
|
||||
debugf("File: validating path %q", path)
|
||||
|
||||
// Basic security check - no path traversal
|
||||
if strings.Contains(path, "..") {
|
||||
return "", fmt.Errorf("file: path cannot contain '..'")
|
||||
}
|
||||
|
||||
// Expand home directory if needed
|
||||
if strings.HasPrefix(path, "~/") {
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not expand home directory: %v", err)
|
||||
}
|
||||
path = filepath.Join(home, path[2:])
|
||||
}
|
||||
|
||||
// Clean the path
|
||||
cleaned := filepath.Clean(path)
|
||||
debugf("File: cleaned path %q", cleaned)
|
||||
return cleaned, nil
|
||||
}
|
||||
|
||||
// Apply executes file operations:
|
||||
@@ -53,145 +53,145 @@ func (p *FilePlugin) safePath(path string) (string, error) {
|
||||
// - size:PATH - Get file size in bytes
|
||||
// - modified:PATH - Get last modified time
|
||||
func (p *FilePlugin) Apply(operation string, value string) (string, error) {
|
||||
debugf("File: operation=%q value=%q", operation, value)
|
||||
|
||||
switch operation {
|
||||
case "tail":
|
||||
parts := strings.Split(value, "|")
|
||||
if len(parts) != 2 {
|
||||
return "", fmt.Errorf("file: tail requires format path|lines")
|
||||
}
|
||||
|
||||
path, err := p.safePath(parts[0])
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
n, err := strconv.Atoi(parts[1])
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: invalid line count %q", parts[1])
|
||||
}
|
||||
|
||||
if n < 1 {
|
||||
return "", fmt.Errorf("file: line count must be positive")
|
||||
}
|
||||
|
||||
lines, err := p.lastNLines(path, n)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
result := strings.Join(lines, "\n")
|
||||
debugf("File: tail returning %d lines", len(lines))
|
||||
return result, nil
|
||||
debugf("File: operation=%q value=%q", operation, value)
|
||||
|
||||
case "read":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not stat file: %v", err)
|
||||
}
|
||||
|
||||
if info.Size() > MaxFileSize {
|
||||
return "", fmt.Errorf("file: size %d exceeds limit of %d bytes",
|
||||
info.Size(), MaxFileSize)
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not read: %v", err)
|
||||
}
|
||||
|
||||
debugf("File: read %d bytes", len(content))
|
||||
return string(content), nil
|
||||
switch operation {
|
||||
case "tail":
|
||||
parts := strings.Split(value, "|")
|
||||
if len(parts) != 2 {
|
||||
return "", fmt.Errorf("file: tail requires format path|lines")
|
||||
}
|
||||
|
||||
case "exists":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
_, err = os.Stat(path)
|
||||
exists := err == nil
|
||||
debugf("File: exists=%v for path %q", exists, path)
|
||||
return fmt.Sprintf("%t", exists), nil
|
||||
path, err := p.safePath(parts[0])
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
case "size":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not stat file: %v", err)
|
||||
}
|
||||
|
||||
size := info.Size()
|
||||
debugf("File: size=%d for path %q", size, path)
|
||||
return fmt.Sprintf("%d", size), nil
|
||||
n, err := strconv.Atoi(parts[1])
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: invalid line count %q", parts[1])
|
||||
}
|
||||
|
||||
case "modified":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not stat file: %v", err)
|
||||
}
|
||||
|
||||
mtime := info.ModTime().Format(time.RFC3339)
|
||||
debugf("File: modified=%q for path %q", mtime, path)
|
||||
return mtime, nil
|
||||
if n < 1 {
|
||||
return "", fmt.Errorf("file: line count must be positive")
|
||||
}
|
||||
|
||||
default:
|
||||
return "", fmt.Errorf("file: unknown operation %q (supported: read, tail, exists, size, modified)",
|
||||
operation)
|
||||
}
|
||||
lines, err := p.lastNLines(path, n)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
result := strings.Join(lines, "\n")
|
||||
debugf("File: tail returning %d lines", len(lines))
|
||||
return result, nil
|
||||
|
||||
case "read":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not stat file: %v", err)
|
||||
}
|
||||
|
||||
if info.Size() > MaxFileSize {
|
||||
return "", fmt.Errorf("file: size %d exceeds limit of %d bytes",
|
||||
info.Size(), MaxFileSize)
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not read: %v", err)
|
||||
}
|
||||
|
||||
debugf("File: read %d bytes", len(content))
|
||||
return string(content), nil
|
||||
|
||||
case "exists":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
_, err = os.Stat(path)
|
||||
exists := err == nil
|
||||
debugf("File: exists=%v for path %q", exists, path)
|
||||
return fmt.Sprintf("%t", exists), nil
|
||||
|
||||
case "size":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not stat file: %v", err)
|
||||
}
|
||||
|
||||
size := info.Size()
|
||||
debugf("File: size=%d for path %q", size, path)
|
||||
return fmt.Sprintf("%d", size), nil
|
||||
|
||||
case "modified":
|
||||
path, err := p.safePath(value)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
info, err := os.Stat(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("file: could not stat file: %v", err)
|
||||
}
|
||||
|
||||
mtime := info.ModTime().Format(time.RFC3339)
|
||||
debugf("File: modified=%q for path %q", mtime, path)
|
||||
return mtime, nil
|
||||
|
||||
default:
|
||||
return "", fmt.Errorf("file: unknown operation %q (supported: read, tail, exists, size, modified)",
|
||||
operation)
|
||||
}
|
||||
}
|
||||
|
||||
// lastNLines returns the last n lines from a file
|
||||
func (p *FilePlugin) lastNLines(path string, n int) ([]string, error) {
|
||||
debugf("File: reading last %d lines from %q", n, path)
|
||||
|
||||
file, err := os.Open(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("file: could not open: %v", err)
|
||||
}
|
||||
defer file.Close()
|
||||
debugf("File: reading last %d lines from %q", n, path)
|
||||
|
||||
info, err := file.Stat()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("file: could not stat: %v", err)
|
||||
}
|
||||
|
||||
if info.Size() > MaxFileSize {
|
||||
return nil, fmt.Errorf("file: size %d exceeds limit of %d bytes",
|
||||
info.Size(), MaxFileSize)
|
||||
}
|
||||
file, err := os.Open(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("file: could not open: %v", err)
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
lines := make([]string, 0, n)
|
||||
scanner := bufio.NewScanner(file)
|
||||
|
||||
lineCount := 0
|
||||
for scanner.Scan() {
|
||||
lineCount++
|
||||
if len(lines) == n {
|
||||
lines = lines[1:]
|
||||
}
|
||||
lines = append(lines, scanner.Text())
|
||||
}
|
||||
|
||||
if err := scanner.Err(); err != nil {
|
||||
return nil, fmt.Errorf("file: error reading: %v", err)
|
||||
}
|
||||
info, err := file.Stat()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("file: could not stat: %v", err)
|
||||
}
|
||||
|
||||
debugf("File: read %d lines total, returning last %d", lineCount, len(lines))
|
||||
return lines, nil
|
||||
if info.Size() > MaxFileSize {
|
||||
return nil, fmt.Errorf("file: size %d exceeds limit of %d bytes",
|
||||
info.Size(), MaxFileSize)
|
||||
}
|
||||
|
||||
lines := make([]string, 0, n)
|
||||
scanner := bufio.NewScanner(file)
|
||||
|
||||
lineCount := 0
|
||||
for scanner.Scan() {
|
||||
lineCount++
|
||||
if len(lines) == n {
|
||||
lines = lines[1:]
|
||||
}
|
||||
lines = append(lines, scanner.Text())
|
||||
}
|
||||
|
||||
if err := scanner.Err(); err != nil {
|
||||
return nil, fmt.Errorf("file: error reading: %v", err)
|
||||
}
|
||||
|
||||
debugf("File: read %d lines total, returning last %d", lineCount, len(lines))
|
||||
return lines, nil
|
||||
}
|
||||
|
||||
@@ -9,144 +9,144 @@ import (
|
||||
)
|
||||
|
||||
func TestFilePlugin(t *testing.T) {
|
||||
plugin := &FilePlugin{}
|
||||
|
||||
// Create temp test files
|
||||
tmpDir := t.TempDir()
|
||||
|
||||
testFile := filepath.Join(tmpDir, "test.txt")
|
||||
content := "line1\nline2\nline3\nline4\nline5\n"
|
||||
err := os.WriteFile(testFile, []byte(content), 0644)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
bigFile := filepath.Join(tmpDir, "big.txt")
|
||||
err = os.WriteFile(bigFile, []byte(strings.Repeat("x", MaxFileSize+1)), 0644)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
plugin := &FilePlugin{}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
want string
|
||||
wantErr bool
|
||||
errContains string
|
||||
validate func(string) bool
|
||||
}{
|
||||
{
|
||||
name: "read file",
|
||||
operation: "read",
|
||||
value: testFile,
|
||||
want: content,
|
||||
},
|
||||
{
|
||||
name: "tail file",
|
||||
operation: "tail",
|
||||
value: testFile + "|3",
|
||||
want: "line3\nline4\nline5",
|
||||
},
|
||||
{
|
||||
name: "exists true",
|
||||
operation: "exists",
|
||||
value: testFile,
|
||||
want: "true",
|
||||
},
|
||||
{
|
||||
name: "exists false",
|
||||
operation: "exists",
|
||||
value: filepath.Join(tmpDir, "nonexistent.txt"),
|
||||
want: "false",
|
||||
},
|
||||
{
|
||||
name: "size",
|
||||
operation: "size",
|
||||
value: testFile,
|
||||
want: "30",
|
||||
},
|
||||
{
|
||||
name: "modified",
|
||||
operation: "modified",
|
||||
value: testFile,
|
||||
validate: func(got string) bool {
|
||||
_, err := time.Parse(time.RFC3339, got)
|
||||
return err == nil
|
||||
},
|
||||
},
|
||||
// Error cases
|
||||
{
|
||||
name: "read non-existent",
|
||||
operation: "read",
|
||||
value: filepath.Join(tmpDir, "nonexistent.txt"),
|
||||
wantErr: true,
|
||||
errContains: "could not stat file",
|
||||
},
|
||||
{
|
||||
name: "invalid operation",
|
||||
operation: "invalid",
|
||||
value: testFile,
|
||||
wantErr: true,
|
||||
errContains: "unknown operation",
|
||||
},
|
||||
{
|
||||
name: "path traversal attempt",
|
||||
operation: "read",
|
||||
value: "../../../etc/passwd",
|
||||
wantErr: true,
|
||||
errContains: "cannot contain '..'",
|
||||
},
|
||||
{
|
||||
name: "file too large",
|
||||
operation: "read",
|
||||
value: bigFile,
|
||||
wantErr: true,
|
||||
errContains: "exceeds limit",
|
||||
},
|
||||
{
|
||||
name: "invalid tail format",
|
||||
operation: "tail",
|
||||
value: testFile,
|
||||
wantErr: true,
|
||||
errContains: "requires format path|lines",
|
||||
},
|
||||
{
|
||||
name: "invalid tail count",
|
||||
operation: "tail",
|
||||
value: testFile + "|invalid",
|
||||
wantErr: true,
|
||||
errContains: "invalid line count",
|
||||
},
|
||||
}
|
||||
// Create temp test files
|
||||
tmpDir := t.TempDir()
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("FilePlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil && tt.errContains != "" {
|
||||
if !strings.Contains(err.Error(), tt.errContains) {
|
||||
t.Errorf("error %q should contain %q", err.Error(), tt.errContains)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Check success cases
|
||||
if err == nil {
|
||||
if tt.validate != nil {
|
||||
if !tt.validate(got) {
|
||||
t.Errorf("FilePlugin.Apply() returned invalid result: %q", got)
|
||||
}
|
||||
} else if tt.want != "" && got != tt.want {
|
||||
t.Errorf("FilePlugin.Apply() = %v, want %v", got, tt.want)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
testFile := filepath.Join(tmpDir, "test.txt")
|
||||
content := "line1\nline2\nline3\nline4\nline5\n"
|
||||
err := os.WriteFile(testFile, []byte(content), 0644)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
bigFile := filepath.Join(tmpDir, "big.txt")
|
||||
err = os.WriteFile(bigFile, []byte(strings.Repeat("x", MaxFileSize+1)), 0644)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
want string
|
||||
wantErr bool
|
||||
errContains string
|
||||
validate func(string) bool
|
||||
}{
|
||||
{
|
||||
name: "read file",
|
||||
operation: "read",
|
||||
value: testFile,
|
||||
want: content,
|
||||
},
|
||||
{
|
||||
name: "tail file",
|
||||
operation: "tail",
|
||||
value: testFile + "|3",
|
||||
want: "line3\nline4\nline5",
|
||||
},
|
||||
{
|
||||
name: "exists true",
|
||||
operation: "exists",
|
||||
value: testFile,
|
||||
want: "true",
|
||||
},
|
||||
{
|
||||
name: "exists false",
|
||||
operation: "exists",
|
||||
value: filepath.Join(tmpDir, "nonexistent.txt"),
|
||||
want: "false",
|
||||
},
|
||||
{
|
||||
name: "size",
|
||||
operation: "size",
|
||||
value: testFile,
|
||||
want: "30",
|
||||
},
|
||||
{
|
||||
name: "modified",
|
||||
operation: "modified",
|
||||
value: testFile,
|
||||
validate: func(got string) bool {
|
||||
_, err := time.Parse(time.RFC3339, got)
|
||||
return err == nil
|
||||
},
|
||||
},
|
||||
// Error cases
|
||||
{
|
||||
name: "read non-existent",
|
||||
operation: "read",
|
||||
value: filepath.Join(tmpDir, "nonexistent.txt"),
|
||||
wantErr: true,
|
||||
errContains: "could not stat file",
|
||||
},
|
||||
{
|
||||
name: "invalid operation",
|
||||
operation: "invalid",
|
||||
value: testFile,
|
||||
wantErr: true,
|
||||
errContains: "unknown operation",
|
||||
},
|
||||
{
|
||||
name: "path traversal attempt",
|
||||
operation: "read",
|
||||
value: "../../../etc/passwd",
|
||||
wantErr: true,
|
||||
errContains: "cannot contain '..'",
|
||||
},
|
||||
{
|
||||
name: "file too large",
|
||||
operation: "read",
|
||||
value: bigFile,
|
||||
wantErr: true,
|
||||
errContains: "exceeds limit",
|
||||
},
|
||||
{
|
||||
name: "invalid tail format",
|
||||
operation: "tail",
|
||||
value: testFile,
|
||||
wantErr: true,
|
||||
errContains: "requires format path|lines",
|
||||
},
|
||||
{
|
||||
name: "invalid tail count",
|
||||
operation: "tail",
|
||||
value: testFile + "|invalid",
|
||||
wantErr: true,
|
||||
errContains: "invalid line count",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("FilePlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil && tt.errContains != "" {
|
||||
if !strings.Contains(err.Error(), tt.errContains) {
|
||||
t.Errorf("error %q should contain %q", err.Error(), tt.errContains)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Check success cases
|
||||
if err == nil {
|
||||
if tt.validate != nil {
|
||||
if !tt.validate(got) {
|
||||
t.Errorf("FilePlugin.Apply() returned invalid result: %q", got)
|
||||
}
|
||||
} else if tt.want != "" && got != tt.want {
|
||||
t.Errorf("FilePlugin.Apply() = %v, want %v", got, tt.want)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
33
plugins/template/hash.go
Normal file
33
plugins/template/hash.go
Normal file
@@ -0,0 +1,33 @@
|
||||
package template
|
||||
|
||||
import (
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
)
|
||||
|
||||
// ComputeHash computes SHA-256 hash of a file at given path.
|
||||
// Returns the hex-encoded hash string or an error if the operation fails.
|
||||
func ComputeHash(path string) (string, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("open file: %w", err)
|
||||
}
|
||||
defer f.Close()
|
||||
|
||||
h := sha256.New()
|
||||
if _, err := io.Copy(h, f); err != nil {
|
||||
return "", fmt.Errorf("read file: %w", err)
|
||||
}
|
||||
|
||||
return hex.EncodeToString(h.Sum(nil)), nil
|
||||
}
|
||||
|
||||
// ComputeStringHash returns hex-encoded SHA-256 hash of the given string
|
||||
func ComputeStringHash(s string) string {
|
||||
h := sha256.New()
|
||||
h.Write([]byte(s))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
119
plugins/template/hash_test.go
Normal file
119
plugins/template/hash_test.go
Normal file
@@ -0,0 +1,119 @@
|
||||
// template/hash_test.go
|
||||
package template
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestComputeHash(t *testing.T) {
|
||||
// Create a temporary test file
|
||||
content := []byte("test content for hashing")
|
||||
tmpfile, err := os.CreateTemp("", "hashtest")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp file: %v", err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write(content); err != nil {
|
||||
t.Fatalf("failed to write to temp file: %v", err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatalf("failed to close temp file: %v", err)
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
path string
|
||||
want string // known hash for test content
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "valid file",
|
||||
path: tmpfile.Name(),
|
||||
want: "e25dd806d495b413931f4eea50b677a7a5c02d00460924661283f211a37f7e7f", // pre-computed hash of "test content for hashing"
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "nonexistent file",
|
||||
path: filepath.Join(os.TempDir(), "nonexistent"),
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := ComputeHash(tt.path)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("ComputeHash() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if got != tt.want && !tt.wantErr {
|
||||
t.Errorf("ComputeHash() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestComputeStringHash(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
input string
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "empty string",
|
||||
input: "",
|
||||
want: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
|
||||
},
|
||||
{
|
||||
name: "simple string",
|
||||
input: "test",
|
||||
want: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
|
||||
},
|
||||
{
|
||||
name: "longer string with spaces",
|
||||
input: "this is a test string",
|
||||
want: "f6774519d1c7a3389ef327e9c04766b999db8cdfb85d1346c471ee86d65885bc",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
if got := ComputeStringHash(tt.input); got != tt.want {
|
||||
t.Errorf("ComputeStringHash() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestHashConsistency ensures both hash functions produce same results for same content
|
||||
func TestHashConsistency(t *testing.T) {
|
||||
content := "test content for consistency check"
|
||||
|
||||
// Create a file with the test content
|
||||
tmpfile, err := os.CreateTemp("", "hashconsistency")
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp file: %v", err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if err := os.WriteFile(tmpfile.Name(), []byte(content), 0644); err != nil {
|
||||
t.Fatalf("failed to write to temp file: %v", err)
|
||||
}
|
||||
|
||||
// Get hashes using both methods
|
||||
fileHash, err := ComputeHash(tmpfile.Name())
|
||||
if err != nil {
|
||||
t.Fatalf("ComputeHash failed: %v", err)
|
||||
}
|
||||
|
||||
stringHash := ComputeStringHash(content)
|
||||
|
||||
// Compare results
|
||||
if fileHash != stringHash {
|
||||
t.Errorf("Hash inconsistency: file hash %v != string hash %v", fileHash, stringHash)
|
||||
}
|
||||
}
|
||||
@@ -22,66 +22,66 @@ type SysPlugin struct{}
|
||||
// - pwd: Current working directory
|
||||
// - home: User's home directory
|
||||
func (p *SysPlugin) Apply(operation string, value string) (string, error) {
|
||||
debugf("Sys: operation=%q value=%q", operation, value)
|
||||
|
||||
switch operation {
|
||||
case "hostname":
|
||||
hostname, err := os.Hostname()
|
||||
if err != nil {
|
||||
debugf("Sys: hostname error: %v", err)
|
||||
return "", fmt.Errorf("sys: hostname error: %v", err)
|
||||
}
|
||||
debugf("Sys: hostname=%q", hostname)
|
||||
return hostname, nil
|
||||
|
||||
case "user":
|
||||
currentUser, err := user.Current()
|
||||
if err != nil {
|
||||
debugf("Sys: user error: %v", err)
|
||||
return "", fmt.Errorf("sys: user error: %v", err)
|
||||
}
|
||||
debugf("Sys: user=%q", currentUser.Username)
|
||||
return currentUser.Username, nil
|
||||
|
||||
case "os":
|
||||
result := runtime.GOOS
|
||||
debugf("Sys: os=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "arch":
|
||||
result := runtime.GOARCH
|
||||
debugf("Sys: arch=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "env":
|
||||
if value == "" {
|
||||
debugf("Sys: env error: missing variable name")
|
||||
return "", fmt.Errorf("sys: env operation requires a variable name")
|
||||
}
|
||||
result := os.Getenv(value)
|
||||
debugf("Sys: env %q=%q", value, result)
|
||||
return result, nil
|
||||
|
||||
case "pwd":
|
||||
dir, err := os.Getwd()
|
||||
if err != nil {
|
||||
debugf("Sys: pwd error: %v", err)
|
||||
return "", fmt.Errorf("sys: pwd error: %v", err)
|
||||
}
|
||||
debugf("Sys: pwd=%q", dir)
|
||||
return dir, nil
|
||||
|
||||
case "home":
|
||||
homeDir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
debugf("Sys: home error: %v", err)
|
||||
return "", fmt.Errorf("sys: home error: %v", err)
|
||||
}
|
||||
debugf("Sys: home=%q", homeDir)
|
||||
return homeDir, nil
|
||||
debugf("Sys: operation=%q value=%q", operation, value)
|
||||
|
||||
default:
|
||||
debugf("Sys: unknown operation %q", operation)
|
||||
return "", fmt.Errorf("sys: unknown operation %q (supported: hostname, user, os, arch, env, pwd, home)", operation)
|
||||
}
|
||||
}
|
||||
switch operation {
|
||||
case "hostname":
|
||||
hostname, err := os.Hostname()
|
||||
if err != nil {
|
||||
debugf("Sys: hostname error: %v", err)
|
||||
return "", fmt.Errorf("sys: hostname error: %v", err)
|
||||
}
|
||||
debugf("Sys: hostname=%q", hostname)
|
||||
return hostname, nil
|
||||
|
||||
case "user":
|
||||
currentUser, err := user.Current()
|
||||
if err != nil {
|
||||
debugf("Sys: user error: %v", err)
|
||||
return "", fmt.Errorf("sys: user error: %v", err)
|
||||
}
|
||||
debugf("Sys: user=%q", currentUser.Username)
|
||||
return currentUser.Username, nil
|
||||
|
||||
case "os":
|
||||
result := runtime.GOOS
|
||||
debugf("Sys: os=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "arch":
|
||||
result := runtime.GOARCH
|
||||
debugf("Sys: arch=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "env":
|
||||
if value == "" {
|
||||
debugf("Sys: env error: missing variable name")
|
||||
return "", fmt.Errorf("sys: env operation requires a variable name")
|
||||
}
|
||||
result := os.Getenv(value)
|
||||
debugf("Sys: env %q=%q", value, result)
|
||||
return result, nil
|
||||
|
||||
case "pwd":
|
||||
dir, err := os.Getwd()
|
||||
if err != nil {
|
||||
debugf("Sys: pwd error: %v", err)
|
||||
return "", fmt.Errorf("sys: pwd error: %v", err)
|
||||
}
|
||||
debugf("Sys: pwd=%q", dir)
|
||||
return dir, nil
|
||||
|
||||
case "home":
|
||||
homeDir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
debugf("Sys: home error: %v", err)
|
||||
return "", fmt.Errorf("sys: home error: %v", err)
|
||||
}
|
||||
debugf("Sys: home=%q", homeDir)
|
||||
return homeDir, nil
|
||||
|
||||
default:
|
||||
debugf("Sys: unknown operation %q", operation)
|
||||
return "", fmt.Errorf("sys: unknown operation %q (supported: hostname, user, os, arch, env, pwd, home)", operation)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,131 +10,131 @@ import (
|
||||
)
|
||||
|
||||
func TestSysPlugin(t *testing.T) {
|
||||
plugin := &SysPlugin{}
|
||||
|
||||
// Set up test environment variable
|
||||
const testEnvVar = "FABRIC_TEST_VAR"
|
||||
const testEnvValue = "test_value"
|
||||
os.Setenv(testEnvVar, testEnvValue)
|
||||
defer os.Unsetenv(testEnvVar)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
validate func(string) error
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "hostname returns valid name",
|
||||
operation: "hostname",
|
||||
validate: func(got string) error {
|
||||
if got == "" {
|
||||
return fmt.Errorf("hostname is empty")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "user returns current user",
|
||||
operation: "user",
|
||||
validate: func(got string) error {
|
||||
if got == "" {
|
||||
return fmt.Errorf("username is empty")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "os returns valid OS",
|
||||
operation: "os",
|
||||
validate: func(got string) error {
|
||||
if got != runtime.GOOS {
|
||||
return fmt.Errorf("expected OS %s, got %s", runtime.GOOS, got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "arch returns valid architecture",
|
||||
operation: "arch",
|
||||
validate: func(got string) error {
|
||||
if got != runtime.GOARCH {
|
||||
return fmt.Errorf("expected arch %s, got %s", runtime.GOARCH, got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "env returns environment variable",
|
||||
operation: "env",
|
||||
value: testEnvVar,
|
||||
validate: func(got string) error {
|
||||
if got != testEnvValue {
|
||||
return fmt.Errorf("expected env var %s, got %s", testEnvValue, got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "pwd returns valid directory",
|
||||
operation: "pwd",
|
||||
validate: func(got string) error {
|
||||
if !filepath.IsAbs(got) {
|
||||
return fmt.Errorf("expected absolute path, got %s", got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "home returns valid home directory",
|
||||
operation: "home",
|
||||
validate: func(got string) error {
|
||||
if !filepath.IsAbs(got) {
|
||||
return fmt.Errorf("expected absolute path, got %s", got)
|
||||
}
|
||||
if !strings.Contains(got, "home") && !strings.Contains(got, "Users") {
|
||||
return fmt.Errorf("path %s doesn't look like a home directory", got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
// Error cases
|
||||
{
|
||||
name: "unknown operation",
|
||||
operation: "invalid",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "env without variable",
|
||||
operation: "env",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "env with non-existent variable",
|
||||
operation: "env",
|
||||
value: "NONEXISTENT_VAR_123456",
|
||||
validate: func(got string) error {
|
||||
if got != "" {
|
||||
return fmt.Errorf("expected empty string for non-existent env var, got %s", got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
}
|
||||
plugin := &SysPlugin{}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("SysPlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if err == nil && tt.validate != nil {
|
||||
if err := tt.validate(got); err != nil {
|
||||
t.Errorf("SysPlugin.Apply() validation failed: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
// Set up test environment variable
|
||||
const testEnvVar = "FABRIC_TEST_VAR"
|
||||
const testEnvValue = "test_value"
|
||||
os.Setenv(testEnvVar, testEnvValue)
|
||||
defer os.Unsetenv(testEnvVar)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
validate func(string) error
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "hostname returns valid name",
|
||||
operation: "hostname",
|
||||
validate: func(got string) error {
|
||||
if got == "" {
|
||||
return fmt.Errorf("hostname is empty")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "user returns current user",
|
||||
operation: "user",
|
||||
validate: func(got string) error {
|
||||
if got == "" {
|
||||
return fmt.Errorf("username is empty")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "os returns valid OS",
|
||||
operation: "os",
|
||||
validate: func(got string) error {
|
||||
if got != runtime.GOOS {
|
||||
return fmt.Errorf("expected OS %s, got %s", runtime.GOOS, got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "arch returns valid architecture",
|
||||
operation: "arch",
|
||||
validate: func(got string) error {
|
||||
if got != runtime.GOARCH {
|
||||
return fmt.Errorf("expected arch %s, got %s", runtime.GOARCH, got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "env returns environment variable",
|
||||
operation: "env",
|
||||
value: testEnvVar,
|
||||
validate: func(got string) error {
|
||||
if got != testEnvValue {
|
||||
return fmt.Errorf("expected env var %s, got %s", testEnvValue, got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "pwd returns valid directory",
|
||||
operation: "pwd",
|
||||
validate: func(got string) error {
|
||||
if !filepath.IsAbs(got) {
|
||||
return fmt.Errorf("expected absolute path, got %s", got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "home returns valid home directory",
|
||||
operation: "home",
|
||||
validate: func(got string) error {
|
||||
if !filepath.IsAbs(got) {
|
||||
return fmt.Errorf("expected absolute path, got %s", got)
|
||||
}
|
||||
if !strings.Contains(got, "home") && !strings.Contains(got, "Users") {
|
||||
return fmt.Errorf("path %s doesn't look like a home directory", got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
// Error cases
|
||||
{
|
||||
name: "unknown operation",
|
||||
operation: "invalid",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "env without variable",
|
||||
operation: "env",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "env with non-existent variable",
|
||||
operation: "env",
|
||||
value: "NONEXISTENT_VAR_123456",
|
||||
validate: func(got string) error {
|
||||
if got != "" {
|
||||
return fmt.Errorf("expected empty string for non-existent env var, got %s", got)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("SysPlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if err == nil && tt.validate != nil {
|
||||
if err := tt.validate(got); err != nil {
|
||||
t.Errorf("SysPlugin.Apply() validation failed: %v", err)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,118 +2,244 @@ package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
var (
|
||||
textPlugin = &TextPlugin{}
|
||||
datetimePlugin = &DateTimePlugin{}
|
||||
filePlugin = &FilePlugin{}
|
||||
fetchPlugin = &FetchPlugin{}
|
||||
sysPlugin = &SysPlugin{}
|
||||
Debug = false // Debug flag
|
||||
textPlugin = &TextPlugin{}
|
||||
datetimePlugin = &DateTimePlugin{}
|
||||
filePlugin = &FilePlugin{}
|
||||
fetchPlugin = &FetchPlugin{}
|
||||
sysPlugin = &SysPlugin{}
|
||||
Debug = false // Debug flag
|
||||
)
|
||||
|
||||
var extensionManager *ExtensionManager
|
||||
|
||||
func init() {
|
||||
homedir, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
debugf("Warning: could not initialize extension manager: %v\n", err)
|
||||
}
|
||||
configDir := filepath.Join(homedir, ".config/fabric")
|
||||
extensionManager = NewExtensionManager(configDir)
|
||||
// Extensions will work if registry exists, otherwise they'll just fail gracefully
|
||||
}
|
||||
|
||||
var pluginPattern = regexp.MustCompile(`\{\{plugin:([^:]+):([^:]+)(?::([^}]+))?\}\}`)
|
||||
var extensionPattern = regexp.MustCompile(`\{\{ext:([^:]+):([^:]+)(?::([^}]+))?\}\}`)
|
||||
|
||||
func debugf(format string, a ...interface{}) {
|
||||
if Debug {
|
||||
fmt.Printf(format, a...)
|
||||
}
|
||||
if Debug {
|
||||
fmt.Printf(format, a...)
|
||||
}
|
||||
}
|
||||
|
||||
func ApplyTemplate(content string, variables map[string]string, input string) (string, error) {
|
||||
var missingVars []string
|
||||
r := regexp.MustCompile(`\{\{([^{}]+)\}\}`)
|
||||
|
||||
debugf("Starting template processing\n")
|
||||
for strings.Contains(content, "{{") {
|
||||
matches := r.FindAllStringSubmatch(content, -1)
|
||||
if len(matches) == 0 {
|
||||
break
|
||||
}
|
||||
|
||||
replaced := false
|
||||
for _, match := range matches {
|
||||
fullMatch := match[0]
|
||||
varName := match[1]
|
||||
|
||||
// Check if this is a plugin call
|
||||
if strings.HasPrefix(varName, "plugin:") {
|
||||
pluginMatches := pluginPattern.FindStringSubmatch(fullMatch)
|
||||
if len(pluginMatches) >= 3 {
|
||||
namespace := pluginMatches[1]
|
||||
operation := pluginMatches[2]
|
||||
value := ""
|
||||
if len(pluginMatches) == 4 {
|
||||
value = pluginMatches[3]
|
||||
}
|
||||
|
||||
debugf("\nPlugin call:\n")
|
||||
debugf(" Namespace: %s\n", namespace)
|
||||
debugf(" Operation: %s\n", operation)
|
||||
debugf(" Value: %s\n", value)
|
||||
|
||||
var result string
|
||||
var err error
|
||||
|
||||
switch namespace {
|
||||
case "text":
|
||||
debugf("Executing text plugin\n")
|
||||
result, err = textPlugin.Apply(operation, value)
|
||||
case "datetime":
|
||||
debugf("Executing datetime plugin\n")
|
||||
result, err = datetimePlugin.Apply(operation, value)
|
||||
case "file":
|
||||
debugf("Executing file plugin\n")
|
||||
result, err = filePlugin.Apply(operation, value)
|
||||
debugf("File plugin result: %#v\n", result)
|
||||
case "fetch":
|
||||
debugf("Executing fetch plugin\n")
|
||||
result, err = fetchPlugin.Apply(operation, value)
|
||||
case "sys":
|
||||
debugf("Executing sys plugin\n")
|
||||
result, err = sysPlugin.Apply(operation, value)
|
||||
default:
|
||||
return "", fmt.Errorf("unknown plugin namespace: %s", namespace)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
debugf("Plugin error: %v\n", err)
|
||||
return "", fmt.Errorf("plugin %s error: %v", namespace, err)
|
||||
}
|
||||
|
||||
debugf("Plugin result: %s\n", result)
|
||||
content = strings.ReplaceAll(content, fullMatch, result)
|
||||
debugf("Content after replacement: %s\n", content)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
// Handle regular variables and input
|
||||
debugf("Processing variable: %s\n", varName)
|
||||
if varName == "input" {
|
||||
debugf("Replacing {{input}}\n")
|
||||
replaced = true
|
||||
content = strings.ReplaceAll(content, fullMatch, input)
|
||||
} else {
|
||||
if val, ok := variables[varName]; !ok {
|
||||
debugf("Missing variable: %s\n", varName)
|
||||
missingVars = append(missingVars, varName)
|
||||
return "", fmt.Errorf("missing required variable: %s", varName)
|
||||
} else {
|
||||
debugf("Replacing variable %s with value: %s\n", varName, val)
|
||||
content = strings.ReplaceAll(content, fullMatch, val)
|
||||
replaced = true
|
||||
}
|
||||
}
|
||||
if !replaced {
|
||||
return "", fmt.Errorf("template processing stuck - potential infinite loop")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
debugf("Template processing complete\n")
|
||||
return content, nil
|
||||
}
|
||||
var missingVars []string
|
||||
r := regexp.MustCompile(`\{\{([^{}]+)\}\}`)
|
||||
|
||||
debugf("Starting template processing\n")
|
||||
for strings.Contains(content, "{{") {
|
||||
matches := r.FindAllStringSubmatch(content, -1)
|
||||
if len(matches) == 0 {
|
||||
break
|
||||
}
|
||||
|
||||
replaced := false
|
||||
for _, match := range matches {
|
||||
fullMatch := match[0]
|
||||
varName := match[1]
|
||||
|
||||
// Check if this is a plugin call
|
||||
if strings.HasPrefix(varName, "plugin:") {
|
||||
pluginMatches := pluginPattern.FindStringSubmatch(fullMatch)
|
||||
if len(pluginMatches) >= 3 {
|
||||
namespace := pluginMatches[1]
|
||||
operation := pluginMatches[2]
|
||||
value := ""
|
||||
if len(pluginMatches) == 4 {
|
||||
value = pluginMatches[3]
|
||||
}
|
||||
|
||||
debugf("\nPlugin call:\n")
|
||||
debugf(" Namespace: %s\n", namespace)
|
||||
debugf(" Operation: %s\n", operation)
|
||||
debugf(" Value: %s\n", value)
|
||||
|
||||
var result string
|
||||
var err error
|
||||
|
||||
switch namespace {
|
||||
case "text":
|
||||
debugf("Executing text plugin\n")
|
||||
result, err = textPlugin.Apply(operation, value)
|
||||
case "datetime":
|
||||
debugf("Executing datetime plugin\n")
|
||||
result, err = datetimePlugin.Apply(operation, value)
|
||||
case "file":
|
||||
debugf("Executing file plugin\n")
|
||||
result, err = filePlugin.Apply(operation, value)
|
||||
debugf("File plugin result: %#v\n", result)
|
||||
case "fetch":
|
||||
debugf("Executing fetch plugin\n")
|
||||
result, err = fetchPlugin.Apply(operation, value)
|
||||
case "sys":
|
||||
debugf("Executing sys plugin\n")
|
||||
result, err = sysPlugin.Apply(operation, value)
|
||||
default:
|
||||
return "", fmt.Errorf("unknown plugin namespace: %s", namespace)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
debugf("Plugin error: %v\n", err)
|
||||
return "", fmt.Errorf("plugin %s error: %v", namespace, err)
|
||||
}
|
||||
|
||||
debugf("Plugin result: %s\n", result)
|
||||
content = strings.ReplaceAll(content, fullMatch, result)
|
||||
debugf("Content after replacement: %s\n", content)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
if pluginMatches := extensionPattern.FindStringSubmatch(fullMatch); len(pluginMatches) >= 3 {
|
||||
name := pluginMatches[1]
|
||||
operation := pluginMatches[2]
|
||||
value := ""
|
||||
if len(pluginMatches) == 4 {
|
||||
value = pluginMatches[3]
|
||||
}
|
||||
|
||||
debugf("\nExtension call:\n")
|
||||
debugf(" Name: %s\n", name)
|
||||
debugf(" Operation: %s\n", operation)
|
||||
debugf(" Value: %s\n", value)
|
||||
|
||||
result, err := extensionManager.ProcessExtension(name, operation, value)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("extension %s error: %v", name, err)
|
||||
}
|
||||
|
||||
content = strings.ReplaceAll(content, fullMatch, result)
|
||||
replaced = true
|
||||
continue
|
||||
}
|
||||
|
||||
// Handle regular variables and input
|
||||
debugf("Processing variable: %s\n", varName)
|
||||
if varName == "input" {
|
||||
debugf("Replacing {{input}}\n")
|
||||
replaced = true
|
||||
content = strings.ReplaceAll(content, fullMatch, input)
|
||||
} else {
|
||||
if val, ok := variables[varName]; !ok {
|
||||
debugf("Missing variable: %s\n", varName)
|
||||
missingVars = append(missingVars, varName)
|
||||
return "", fmt.Errorf("missing required variable: %s", varName)
|
||||
} else {
|
||||
debugf("Replacing variable %s with value: %s\n", varName, val)
|
||||
content = strings.ReplaceAll(content, fullMatch, val)
|
||||
replaced = true
|
||||
}
|
||||
}
|
||||
if !replaced {
|
||||
return "", fmt.Errorf("template processing stuck - potential infinite loop")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
debugf("Starting template processing\n")
|
||||
for strings.Contains(content, "{{") {
|
||||
matches := r.FindAllStringSubmatch(content, -1)
|
||||
if len(matches) == 0 {
|
||||
break
|
||||
}
|
||||
|
||||
replaced := false
|
||||
for _, match := range matches {
|
||||
fullMatch := match[0]
|
||||
varName := match[1]
|
||||
|
||||
// Check if this is a plugin call
|
||||
if strings.HasPrefix(varName, "plugin:") {
|
||||
pluginMatches := pluginPattern.FindStringSubmatch(fullMatch)
|
||||
if len(pluginMatches) >= 3 {
|
||||
namespace := pluginMatches[1]
|
||||
operation := pluginMatches[2]
|
||||
value := ""
|
||||
if len(pluginMatches) == 4 {
|
||||
value = pluginMatches[3]
|
||||
}
|
||||
|
||||
debugf("\nPlugin call:\n")
|
||||
debugf(" Namespace: %s\n", namespace)
|
||||
debugf(" Operation: %s\n", operation)
|
||||
debugf(" Value: %s\n", value)
|
||||
|
||||
var result string
|
||||
var err error
|
||||
|
||||
switch namespace {
|
||||
case "text":
|
||||
debugf("Executing text plugin\n")
|
||||
result, err = textPlugin.Apply(operation, value)
|
||||
case "datetime":
|
||||
debugf("Executing datetime plugin\n")
|
||||
result, err = datetimePlugin.Apply(operation, value)
|
||||
case "file":
|
||||
debugf("Executing file plugin\n")
|
||||
result, err = filePlugin.Apply(operation, value)
|
||||
debugf("File plugin result: %#v\n", result)
|
||||
case "fetch":
|
||||
debugf("Executing fetch plugin\n")
|
||||
result, err = fetchPlugin.Apply(operation, value)
|
||||
case "sys":
|
||||
debugf("Executing sys plugin\n")
|
||||
result, err = sysPlugin.Apply(operation, value)
|
||||
default:
|
||||
return "", fmt.Errorf("unknown plugin namespace: %s", namespace)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
debugf("Plugin error: %v\n", err)
|
||||
return "", fmt.Errorf("plugin %s error: %v", namespace, err)
|
||||
}
|
||||
|
||||
debugf("Plugin result: %s\n", result)
|
||||
content = strings.ReplaceAll(content, fullMatch, result)
|
||||
debugf("Content after replacement: %s\n", content)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
// Handle regular variables and input
|
||||
debugf("Processing variable: %s\n", varName)
|
||||
if varName == "input" {
|
||||
debugf("Replacing {{input}}\n")
|
||||
replaced = true
|
||||
content = strings.ReplaceAll(content, fullMatch, input)
|
||||
} else {
|
||||
if val, ok := variables[varName]; !ok {
|
||||
debugf("Missing variable: %s\n", varName)
|
||||
missingVars = append(missingVars, varName)
|
||||
return "", fmt.Errorf("missing required variable: %s", varName)
|
||||
} else {
|
||||
debugf("Replacing variable %s with value: %s\n", varName, val)
|
||||
content = strings.ReplaceAll(content, fullMatch, val)
|
||||
replaced = true
|
||||
}
|
||||
}
|
||||
if !replaced {
|
||||
return "", fmt.Errorf("template processing stuck - potential infinite loop")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
debugf("Template processing complete\n")
|
||||
return content, nil
|
||||
}
|
||||
|
||||
@@ -6,141 +6,140 @@ import (
|
||||
)
|
||||
|
||||
func TestApplyTemplate(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
template string
|
||||
vars map[string]string
|
||||
input string
|
||||
want string
|
||||
wantErr bool
|
||||
errContains string
|
||||
}{
|
||||
// Basic variable substitution
|
||||
{
|
||||
name: "simple variable",
|
||||
template: "Hello {{name}}!",
|
||||
vars: map[string]string{"name": "World"},
|
||||
want: "Hello World!",
|
||||
},
|
||||
{
|
||||
name: "multiple variables",
|
||||
template: "{{greeting}} {{name}}!",
|
||||
vars: map[string]string{
|
||||
"greeting": "Hello",
|
||||
"name": "World",
|
||||
},
|
||||
want: "Hello World!",
|
||||
},
|
||||
{
|
||||
name: "special input variable",
|
||||
template: "Content: {{input}}",
|
||||
input: "test content",
|
||||
want: "Content: test content",
|
||||
},
|
||||
|
||||
// Nested variable substitution
|
||||
{
|
||||
name: "nested variables",
|
||||
template: "{{outer{{inner}}}}",
|
||||
vars: map[string]string{
|
||||
"inner": "foo", // First resolution
|
||||
"outerfoo": "result", // Second resolution
|
||||
},
|
||||
want: "result",
|
||||
},
|
||||
|
||||
// Plugin operations
|
||||
{
|
||||
name: "simple text plugin",
|
||||
template: "{{plugin:text:upper:hello}}",
|
||||
want: "HELLO",
|
||||
},
|
||||
{
|
||||
name: "text plugin with variable",
|
||||
template: "{{plugin:text:upper:{{name}}}}",
|
||||
vars: map[string]string{"name": "world"},
|
||||
want: "WORLD",
|
||||
},
|
||||
{
|
||||
name: "plugin with dynamic operation",
|
||||
template: "{{plugin:text:{{operation}}:hello}}",
|
||||
vars: map[string]string{"operation": "upper"},
|
||||
want: "HELLO",
|
||||
},
|
||||
|
||||
// Multiple operations
|
||||
{
|
||||
name: "multiple plugins",
|
||||
template: "A:{{plugin:text:upper:hello}} B:{{plugin:text:lower:WORLD}}",
|
||||
want: "A:HELLO B:world",
|
||||
},
|
||||
{
|
||||
name: "nested plugins",
|
||||
template: "{{plugin:text:upper:{{plugin:text:lower:HELLO}}}}",
|
||||
want: "HELLO",
|
||||
},
|
||||
|
||||
// Error cases
|
||||
{
|
||||
name: "missing variable",
|
||||
template: "Hello {{name}}!",
|
||||
wantErr: true,
|
||||
errContains: "missing required variable",
|
||||
},
|
||||
{
|
||||
name: "unknown plugin",
|
||||
template: "{{plugin:invalid:op:value}}",
|
||||
wantErr: true,
|
||||
errContains: "unknown plugin namespace",
|
||||
},
|
||||
{
|
||||
name: "unknown plugin operation",
|
||||
template: "{{plugin:text:invalid:value}}",
|
||||
wantErr: true,
|
||||
errContains: "unknown text operation",
|
||||
},
|
||||
{
|
||||
name: "nested plugin error",
|
||||
template: "{{plugin:text:upper:{{plugin:invalid:op:value}}}}",
|
||||
wantErr: true,
|
||||
errContains: "unknown plugin namespace",
|
||||
},
|
||||
|
||||
// Edge cases
|
||||
{
|
||||
name: "empty template",
|
||||
template: "",
|
||||
want: "",
|
||||
},
|
||||
{
|
||||
name: "no substitutions needed",
|
||||
template: "plain text",
|
||||
want: "plain text",
|
||||
},
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
template string
|
||||
vars map[string]string
|
||||
input string
|
||||
want string
|
||||
wantErr bool
|
||||
errContains string
|
||||
}{
|
||||
// Basic variable substitution
|
||||
{
|
||||
name: "simple variable",
|
||||
template: "Hello {{name}}!",
|
||||
vars: map[string]string{"name": "World"},
|
||||
want: "Hello World!",
|
||||
},
|
||||
{
|
||||
name: "multiple variables",
|
||||
template: "{{greeting}} {{name}}!",
|
||||
vars: map[string]string{
|
||||
"greeting": "Hello",
|
||||
"name": "World",
|
||||
},
|
||||
want: "Hello World!",
|
||||
},
|
||||
{
|
||||
name: "special input variable",
|
||||
template: "Content: {{input}}",
|
||||
input: "test content",
|
||||
want: "Content: test content",
|
||||
},
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := ApplyTemplate(tt.template, tt.vars, tt.input)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("ApplyTemplate() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil && tt.errContains != "" {
|
||||
if !strings.Contains(err.Error(), tt.errContains) {
|
||||
t.Errorf("error %q should contain %q", err.Error(), tt.errContains)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Check result
|
||||
if got != tt.want {
|
||||
t.Errorf("ApplyTemplate() = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
// Nested variable substitution
|
||||
{
|
||||
name: "nested variables",
|
||||
template: "{{outer{{inner}}}}",
|
||||
vars: map[string]string{
|
||||
"inner": "foo", // First resolution
|
||||
"outerfoo": "result", // Second resolution
|
||||
},
|
||||
want: "result",
|
||||
},
|
||||
|
||||
// Plugin operations
|
||||
{
|
||||
name: "simple text plugin",
|
||||
template: "{{plugin:text:upper:hello}}",
|
||||
want: "HELLO",
|
||||
},
|
||||
{
|
||||
name: "text plugin with variable",
|
||||
template: "{{plugin:text:upper:{{name}}}}",
|
||||
vars: map[string]string{"name": "world"},
|
||||
want: "WORLD",
|
||||
},
|
||||
{
|
||||
name: "plugin with dynamic operation",
|
||||
template: "{{plugin:text:{{operation}}:hello}}",
|
||||
vars: map[string]string{"operation": "upper"},
|
||||
want: "HELLO",
|
||||
},
|
||||
|
||||
// Multiple operations
|
||||
{
|
||||
name: "multiple plugins",
|
||||
template: "A:{{plugin:text:upper:hello}} B:{{plugin:text:lower:WORLD}}",
|
||||
want: "A:HELLO B:world",
|
||||
},
|
||||
{
|
||||
name: "nested plugins",
|
||||
template: "{{plugin:text:upper:{{plugin:text:lower:HELLO}}}}",
|
||||
want: "HELLO",
|
||||
},
|
||||
|
||||
// Error cases
|
||||
{
|
||||
name: "missing variable",
|
||||
template: "Hello {{name}}!",
|
||||
wantErr: true,
|
||||
errContains: "missing required variable",
|
||||
},
|
||||
{
|
||||
name: "unknown plugin",
|
||||
template: "{{plugin:invalid:op:value}}",
|
||||
wantErr: true,
|
||||
errContains: "unknown plugin namespace",
|
||||
},
|
||||
{
|
||||
name: "unknown plugin operation",
|
||||
template: "{{plugin:text:invalid:value}}",
|
||||
wantErr: true,
|
||||
errContains: "unknown text operation",
|
||||
},
|
||||
{
|
||||
name: "nested plugin error",
|
||||
template: "{{plugin:text:upper:{{plugin:invalid:op:value}}}}",
|
||||
wantErr: true,
|
||||
errContains: "unknown plugin namespace",
|
||||
},
|
||||
|
||||
// Edge cases
|
||||
{
|
||||
name: "empty template",
|
||||
template: "",
|
||||
want: "",
|
||||
},
|
||||
{
|
||||
name: "no substitutions needed",
|
||||
template: "plain text",
|
||||
want: "plain text",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := ApplyTemplate(tt.template, tt.vars, tt.input)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("ApplyTemplate() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
if err != nil && tt.errContains != "" {
|
||||
if !strings.Contains(err.Error(), tt.errContains) {
|
||||
t.Errorf("error %q should contain %q", err.Error(), tt.errContains)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// Check result
|
||||
if got != tt.want {
|
||||
t.Errorf("ApplyTemplate() = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -12,53 +12,53 @@ type TextPlugin struct{}
|
||||
|
||||
// toTitle capitalizes a letter if it follows a non-letter, unless next char is space
|
||||
func toTitle(s string) string {
|
||||
// First lowercase everything
|
||||
lower := strings.ToLower(s)
|
||||
runes := []rune(lower)
|
||||
|
||||
for i := 0; i < len(runes); i++ {
|
||||
// Capitalize if previous char is non-letter AND
|
||||
// (we're at the end OR next char is not space)
|
||||
if (i == 0 || !unicode.IsLetter(runes[i-1])) {
|
||||
if i == len(runes)-1 || !unicode.IsSpace(runes[i+1]) {
|
||||
runes[i] = unicode.ToUpper(runes[i])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return string(runes)
|
||||
// First lowercase everything
|
||||
lower := strings.ToLower(s)
|
||||
runes := []rune(lower)
|
||||
|
||||
for i := 0; i < len(runes); i++ {
|
||||
// Capitalize if previous char is non-letter AND
|
||||
// (we're at the end OR next char is not space)
|
||||
if i == 0 || !unicode.IsLetter(runes[i-1]) {
|
||||
if i == len(runes)-1 || !unicode.IsSpace(runes[i+1]) {
|
||||
runes[i] = unicode.ToUpper(runes[i])
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return string(runes)
|
||||
}
|
||||
|
||||
// Apply executes the requested text operation on the provided value
|
||||
func (p *TextPlugin) Apply(operation string, value string) (string, error) {
|
||||
debugf("TextPlugin: operation=%s value=%q", operation, value)
|
||||
|
||||
if value == "" {
|
||||
return "", fmt.Errorf("text: empty input for operation %q", operation)
|
||||
}
|
||||
debugf("TextPlugin: operation=%s value=%q", operation, value)
|
||||
|
||||
switch operation {
|
||||
case "upper":
|
||||
result := strings.ToUpper(value)
|
||||
debugf("TextPlugin: upper result=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "lower":
|
||||
result := strings.ToLower(value)
|
||||
debugf("TextPlugin: lower result=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "title":
|
||||
result := toTitle(value)
|
||||
debugf("TextPlugin: title result=%q", result)
|
||||
return result, nil
|
||||
if value == "" {
|
||||
return "", fmt.Errorf("text: empty input for operation %q", operation)
|
||||
}
|
||||
|
||||
case "trim":
|
||||
result := strings.TrimSpace(value)
|
||||
debugf("TextPlugin: trim result=%q", result)
|
||||
return result, nil
|
||||
|
||||
default:
|
||||
return "", fmt.Errorf("text: unknown text operation %q (supported: upper, lower, title, trim)", operation)
|
||||
}
|
||||
}
|
||||
switch operation {
|
||||
case "upper":
|
||||
result := strings.ToUpper(value)
|
||||
debugf("TextPlugin: upper result=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "lower":
|
||||
result := strings.ToLower(value)
|
||||
debugf("TextPlugin: lower result=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "title":
|
||||
result := toTitle(value)
|
||||
debugf("TextPlugin: title result=%q", result)
|
||||
return result, nil
|
||||
|
||||
case "trim":
|
||||
result := strings.TrimSpace(value)
|
||||
debugf("TextPlugin: trim result=%q", result)
|
||||
return result, nil
|
||||
|
||||
default:
|
||||
return "", fmt.Errorf("text: unknown text operation %q (supported: upper, lower, title, trim)", operation)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,100 +5,100 @@ import (
|
||||
)
|
||||
|
||||
func TestTextPlugin(t *testing.T) {
|
||||
plugin := &TextPlugin{}
|
||||
plugin := &TextPlugin{}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
want string
|
||||
wantErr bool
|
||||
}{
|
||||
// Upper tests
|
||||
{
|
||||
name: "upper basic",
|
||||
operation: "upper",
|
||||
value: "hello",
|
||||
want: "HELLO",
|
||||
},
|
||||
{
|
||||
name: "upper mixed case",
|
||||
operation: "upper",
|
||||
value: "hElLo",
|
||||
want: "HELLO",
|
||||
},
|
||||
|
||||
// Lower tests
|
||||
{
|
||||
name: "lower basic",
|
||||
operation: "lower",
|
||||
value: "HELLO",
|
||||
want: "hello",
|
||||
},
|
||||
{
|
||||
name: "lower mixed case",
|
||||
operation: "lower",
|
||||
value: "hElLo",
|
||||
want: "hello",
|
||||
},
|
||||
|
||||
// Title tests
|
||||
{
|
||||
name: "title basic",
|
||||
operation: "title",
|
||||
value: "hello world",
|
||||
want: "Hello World",
|
||||
},
|
||||
{
|
||||
name: "title with apostrophe",
|
||||
operation: "title",
|
||||
value: "o'reilly's book",
|
||||
want: "O'Reilly's Book",
|
||||
},
|
||||
|
||||
// Trim tests
|
||||
{
|
||||
name: "trim spaces",
|
||||
operation: "trim",
|
||||
value: " hello ",
|
||||
want: "hello",
|
||||
},
|
||||
{
|
||||
name: "trim newlines",
|
||||
operation: "trim",
|
||||
value: "\nhello\n",
|
||||
want: "hello",
|
||||
},
|
||||
|
||||
// Error cases
|
||||
{
|
||||
name: "empty value",
|
||||
operation: "upper",
|
||||
value: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "unknown operation",
|
||||
operation: "invalid",
|
||||
value: "test",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
operation string
|
||||
value string
|
||||
want string
|
||||
wantErr bool
|
||||
}{
|
||||
// Upper tests
|
||||
{
|
||||
name: "upper basic",
|
||||
operation: "upper",
|
||||
value: "hello",
|
||||
want: "HELLO",
|
||||
},
|
||||
{
|
||||
name: "upper mixed case",
|
||||
operation: "upper",
|
||||
value: "hElLo",
|
||||
want: "HELLO",
|
||||
},
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("TextPlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
// Check successful cases
|
||||
if err == nil && got != tt.want {
|
||||
t.Errorf("TextPlugin.Apply() = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
// Lower tests
|
||||
{
|
||||
name: "lower basic",
|
||||
operation: "lower",
|
||||
value: "HELLO",
|
||||
want: "hello",
|
||||
},
|
||||
{
|
||||
name: "lower mixed case",
|
||||
operation: "lower",
|
||||
value: "hElLo",
|
||||
want: "hello",
|
||||
},
|
||||
|
||||
// Title tests
|
||||
{
|
||||
name: "title basic",
|
||||
operation: "title",
|
||||
value: "hello world",
|
||||
want: "Hello World",
|
||||
},
|
||||
{
|
||||
name: "title with apostrophe",
|
||||
operation: "title",
|
||||
value: "o'reilly's book",
|
||||
want: "O'Reilly's Book",
|
||||
},
|
||||
|
||||
// Trim tests
|
||||
{
|
||||
name: "trim spaces",
|
||||
operation: "trim",
|
||||
value: " hello ",
|
||||
want: "hello",
|
||||
},
|
||||
{
|
||||
name: "trim newlines",
|
||||
operation: "trim",
|
||||
value: "\nhello\n",
|
||||
want: "hello",
|
||||
},
|
||||
|
||||
// Error cases
|
||||
{
|
||||
name: "empty value",
|
||||
operation: "upper",
|
||||
value: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "unknown operation",
|
||||
operation: "invalid",
|
||||
value: "test",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := plugin.Apply(tt.operation, tt.value)
|
||||
|
||||
// Check error cases
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("TextPlugin.Apply() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
|
||||
// Check successful cases
|
||||
if err == nil && got != tt.want {
|
||||
t.Errorf("TextPlugin.Apply() = %q, want %q", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
41
plugins/template/utils.go
Normal file
41
plugins/template/utils.go
Normal file
@@ -0,0 +1,41 @@
|
||||
// utils.go in template package for now
|
||||
package template
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"os/user"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ExpandPath expands the ~ to user's home directory and returns absolute path
|
||||
// It also checks if the path exists
|
||||
// Returns expanded absolute path or error if:
|
||||
// - cannot determine user home directory
|
||||
// - cannot convert to absolute path
|
||||
// - path doesn't exist
|
||||
func ExpandPath(path string) (string, error) {
|
||||
// If path starts with ~
|
||||
if strings.HasPrefix(path, "~/") {
|
||||
usr, err := user.Current()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get user home directory: %w", err)
|
||||
}
|
||||
// Replace ~/ with actual home directory
|
||||
path = filepath.Join(usr.HomeDir, path[2:])
|
||||
}
|
||||
|
||||
// Convert to absolute path
|
||||
absPath, err := filepath.Abs(path)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get absolute path: %w", err)
|
||||
}
|
||||
|
||||
// Check if path exists
|
||||
if _, err := os.Stat(absPath); err != nil {
|
||||
return "", fmt.Errorf("path does not exist: %w", err)
|
||||
}
|
||||
|
||||
return absPath, nil
|
||||
}
|
||||
@@ -76,12 +76,19 @@ func main() {
|
||||
}
|
||||
|
||||
// Move the output PDF to the current directory
|
||||
err = os.Rename(pdfPath, outputFile)
|
||||
err = copyFile(pdfPath, outputFile)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error moving output file: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Remove the original file after copying
|
||||
err = os.Remove(pdfPath)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error cleaning up temporary file: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Clean up temporary files
|
||||
cleanupTempFiles(tmpDir)
|
||||
|
||||
@@ -103,3 +110,25 @@ func cleanupTempFiles(dir string) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Copy a file from source src to destination dst
|
||||
func copyFile(src, dst string) error {
|
||||
sourceFile, err := os.Open(src)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer sourceFile.Close()
|
||||
|
||||
destFile, err := os.Create(dst)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer destFile.Close()
|
||||
|
||||
_, err = io.Copy(destFile, sourceFile)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return destFile.Sync()
|
||||
}
|
||||
|
||||
211
restapi/chat.go
Executable file
211
restapi/chat.go
Executable file
@@ -0,0 +1,211 @@
|
||||
package restapi
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
goopenai "github.com/sashabaranov/go-openai"
|
||||
|
||||
"github.com/danielmiessler/fabric/common"
|
||||
"github.com/danielmiessler/fabric/core"
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
type ChatHandler struct {
|
||||
registry *core.PluginRegistry
|
||||
db *fsdb.Db
|
||||
}
|
||||
|
||||
type PromptRequest struct {
|
||||
UserInput string `json:"userInput"`
|
||||
Vendor string `json:"vendor"`
|
||||
Model string `json:"model"`
|
||||
ContextName string `json:"contextName"`
|
||||
PatternName string `json:"patternName"`
|
||||
}
|
||||
|
||||
type ChatRequest struct {
|
||||
Prompts []PromptRequest `json:"prompts"`
|
||||
common.ChatOptions // Embed the ChatOptions from common package
|
||||
}
|
||||
|
||||
type StreamResponse struct {
|
||||
Type string `json:"type"` // "content", "error", "complete"
|
||||
Format string `json:"format"` // "markdown", "mermaid", "plain"
|
||||
Content string `json:"content"` // The actual content
|
||||
}
|
||||
|
||||
func NewChatHandler(r *gin.Engine, registry *core.PluginRegistry, db *fsdb.Db) *ChatHandler {
|
||||
handler := &ChatHandler{
|
||||
registry: registry,
|
||||
db: db,
|
||||
}
|
||||
|
||||
r.POST("/chat", handler.HandleChat)
|
||||
|
||||
return handler
|
||||
}
|
||||
|
||||
func (h *ChatHandler) HandleChat(c *gin.Context) {
|
||||
var request ChatRequest
|
||||
|
||||
if err := c.BindJSON(&request); err != nil {
|
||||
log.Printf("Error binding JSON: %v", err)
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": fmt.Sprintf("Invalid request format: %v", err)})
|
||||
return
|
||||
}
|
||||
|
||||
log.Printf("Received chat request with %d prompts", len(request.Prompts))
|
||||
|
||||
// Set headers for SSE
|
||||
c.Writer.Header().Set("Content-Type", "text/readystream")
|
||||
c.Writer.Header().Set("Cache-Control", "no-cache")
|
||||
c.Writer.Header().Set("Connection", "keep-alive")
|
||||
c.Writer.Header().Set("Access-Control-Allow-Origin", "http://localhost:5173")
|
||||
c.Writer.Header().Set("X-Accel-Buffering", "no")
|
||||
|
||||
clientGone := c.Writer.CloseNotify()
|
||||
|
||||
for i, prompt := range request.Prompts {
|
||||
select {
|
||||
case <-clientGone:
|
||||
log.Printf("Client disconnected")
|
||||
return
|
||||
default:
|
||||
log.Printf("Processing prompt %d: Model=%s Pattern=%s Context=%s",
|
||||
i+1, prompt.Model, prompt.PatternName, prompt.ContextName)
|
||||
|
||||
// Create chat channel for streaming
|
||||
streamChan := make(chan string)
|
||||
|
||||
// Start chat processing in goroutine
|
||||
go func(p PromptRequest) {
|
||||
defer close(streamChan)
|
||||
|
||||
chatter, err := h.registry.GetChatter(p.Model, 2048, false, false)
|
||||
if err != nil {
|
||||
log.Printf("Error creating chatter: %v", err)
|
||||
streamChan <- fmt.Sprintf("Error: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
chatReq := &common.ChatRequest{
|
||||
Message: &goopenai.ChatCompletionMessage{
|
||||
Role: "user",
|
||||
Content: p.UserInput,
|
||||
},
|
||||
PatternName: p.PatternName,
|
||||
ContextName: p.ContextName,
|
||||
}
|
||||
|
||||
opts := &common.ChatOptions{
|
||||
Model: p.Model,
|
||||
Temperature: request.Temperature,
|
||||
TopP: request.TopP,
|
||||
FrequencyPenalty: request.FrequencyPenalty,
|
||||
PresencePenalty: request.PresencePenalty,
|
||||
}
|
||||
|
||||
session, err := chatter.Send(chatReq, opts)
|
||||
if err != nil {
|
||||
log.Printf("Error from chatter.Send: %v", err)
|
||||
streamChan <- fmt.Sprintf("Error: %v", err)
|
||||
return
|
||||
}
|
||||
|
||||
if session == nil {
|
||||
log.Printf("No session returned from chatter.Send")
|
||||
streamChan <- "Error: No response from model"
|
||||
return
|
||||
}
|
||||
|
||||
// Get the last message from the session
|
||||
lastMsg := session.GetLastMessage()
|
||||
if lastMsg != nil {
|
||||
streamChan <- lastMsg.Content
|
||||
} else {
|
||||
log.Printf("No message content in session")
|
||||
streamChan <- "Error: No response content"
|
||||
}
|
||||
}(prompt)
|
||||
|
||||
// Read from streamChan and write to client
|
||||
for content := range streamChan {
|
||||
select {
|
||||
case <-clientGone:
|
||||
return
|
||||
default:
|
||||
if strings.HasPrefix(content, "Error:") {
|
||||
response := StreamResponse{
|
||||
Type: "error",
|
||||
Format: "plain",
|
||||
Content: content,
|
||||
}
|
||||
if err := writeSSEResponse(c.Writer, response); err != nil {
|
||||
log.Printf("Error writing error response: %v", err)
|
||||
return
|
||||
}
|
||||
} else {
|
||||
response := StreamResponse{
|
||||
Type: "content",
|
||||
Format: detectFormat(content),
|
||||
Content: content,
|
||||
}
|
||||
if err := writeSSEResponse(c.Writer, response); err != nil {
|
||||
log.Printf("Error writing content response: %v", err)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Signal completion of this prompt
|
||||
completeResponse := StreamResponse{
|
||||
Type: "complete",
|
||||
Format: "plain",
|
||||
Content: "",
|
||||
}
|
||||
if err := writeSSEResponse(c.Writer, completeResponse); err != nil {
|
||||
log.Printf("Error writing completion response: %v", err)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func writeSSEResponse(w gin.ResponseWriter, response StreamResponse) error {
|
||||
data, err := json.Marshal(response)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error marshaling response: %v", err)
|
||||
}
|
||||
|
||||
if _, err := fmt.Fprintf(w, "data: %s\n\n", string(data)); err != nil {
|
||||
return fmt.Errorf("error writing response: %v", err)
|
||||
}
|
||||
|
||||
w.(http.Flusher).Flush()
|
||||
return nil
|
||||
}
|
||||
|
||||
func detectFormat(content string) string {
|
||||
if strings.HasPrefix(content, "graph TD") ||
|
||||
strings.HasPrefix(content, "gantt") ||
|
||||
strings.HasPrefix(content, "flowchart") ||
|
||||
strings.HasPrefix(content, "sequenceDiagram") ||
|
||||
strings.HasPrefix(content, "classDiagram") ||
|
||||
strings.HasPrefix(content, "stateDiagram") {
|
||||
return "mermaid"
|
||||
}
|
||||
if strings.Contains(content, "```") ||
|
||||
strings.Contains(content, "#") ||
|
||||
strings.Contains(content, "*") ||
|
||||
strings.Contains(content, "_") ||
|
||||
strings.Contains(content, "-") {
|
||||
return "markdown"
|
||||
}
|
||||
return "plain"
|
||||
}
|
||||
124
restapi/configuration.go
Executable file
124
restapi/configuration.go
Executable file
@@ -0,0 +1,124 @@
|
||||
package restapi
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/danielmiessler/fabric/plugins/db/fsdb"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
// ConfigHandler defines the handler for configuration-related operations
|
||||
type ConfigHandler struct {
|
||||
db *fsdb.Db
|
||||
// configurations *fsdb.EnvFilePath("$HOME/.config/fabric/.env")
|
||||
}
|
||||
|
||||
func NewConfigHandler(r *gin.Engine, db *fsdb.Db) *ConfigHandler {
|
||||
handler := &ConfigHandler{
|
||||
db: db,
|
||||
// configurations: db.Configurations,
|
||||
}
|
||||
|
||||
r.GET("/config", handler.GetConfig)
|
||||
r.POST("/config/update", handler.UpdateConfig)
|
||||
|
||||
return handler
|
||||
}
|
||||
|
||||
func (h *ConfigHandler) GetConfig(c *gin.Context) {
|
||||
if h.db == nil {
|
||||
c.JSON(http.StatusNotFound, gin.H{"error": ".env file not found"})
|
||||
return
|
||||
}
|
||||
|
||||
if !h.db.IsEnvFileExists() {
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"openai": "",
|
||||
"anthropic": "",
|
||||
"groq": "",
|
||||
"mistral": "",
|
||||
"gemini": "",
|
||||
"ollama": "",
|
||||
"openrouter": "",
|
||||
"silicon": "",
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
err := h.db.LoadEnvFile()
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
config := map[string]string{
|
||||
"openai": os.Getenv("OPENAI_API_KEY"),
|
||||
"anthropic": os.Getenv("ANTHROPIC_API_KEY"),
|
||||
"groq": os.Getenv("GROQ_API_KEY"),
|
||||
"mistral": os.Getenv("MISTRAL_API_KEY"),
|
||||
"gemini": os.Getenv("GEMINI_API_KEY"),
|
||||
"ollama": os.Getenv("OLLAMA_URL"),
|
||||
"openrouter": os.Getenv("OPENROUTER_API_KEY"),
|
||||
"silicon": os.Getenv("SILICON_API_KEY"),
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, config)
|
||||
}
|
||||
|
||||
func (h *ConfigHandler) UpdateConfig(c *gin.Context) {
|
||||
if h.db == nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "Database not initialized"})
|
||||
return
|
||||
}
|
||||
|
||||
var config struct {
|
||||
OpenAIApiKey string `json:"openai_api_key"`
|
||||
AnthropicApiKey string `json:"anthropic_api_key"`
|
||||
GroqApiKey string `json:"groq_api_key"`
|
||||
MistralApiKey string `json:"mistral_api_key"`
|
||||
GeminiApiKey string `json:"gemini_api_key"`
|
||||
OllamaURL string `json:"ollama_url"`
|
||||
OpenRouterApiKey string `json:"openrouter_api_key"`
|
||||
SiliconApiKey string `json:"silicon_api_key"`
|
||||
}
|
||||
|
||||
if err := c.BindJSON(&config); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
envVars := map[string]string{
|
||||
"OPENAI_API_KEY": config.OpenAIApiKey,
|
||||
"ANTHROPIC_API_KEY": config.AnthropicApiKey,
|
||||
"GROQ_API_KEY": config.GroqApiKey,
|
||||
"MISTRAL_API_KEY": config.MistralApiKey,
|
||||
"GEMINI_API_KEY": config.GeminiApiKey,
|
||||
"OLLAMA_URL": config.OllamaURL,
|
||||
"OPENROUTER_API_KEY": config.OpenRouterApiKey,
|
||||
"SILICON_API_KEY": config.SiliconApiKey,
|
||||
}
|
||||
|
||||
var envContent strings.Builder
|
||||
for key, value := range envVars {
|
||||
if value != "" {
|
||||
envContent.WriteString(fmt.Sprintf("%s=%s\n", key, value))
|
||||
os.Setenv(key, value)
|
||||
}
|
||||
}
|
||||
|
||||
// Save configuration to file
|
||||
if err := h.db.SaveEnv(envContent.String()); err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
if err := h.db.LoadEnvFile(); err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{"message": "Configuration updated successfully"})
|
||||
}
|
||||
45
restapi/models.go
Executable file
45
restapi/models.go
Executable file
@@ -0,0 +1,45 @@
|
||||
package restapi
|
||||
|
||||
import (
|
||||
"github.com/danielmiessler/fabric/plugins/ai"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
type ModelsHandler struct {
|
||||
vendorManager *ai.VendorsManager
|
||||
}
|
||||
|
||||
func NewModelsHandler(r *gin.Engine, vendorManager *ai.VendorsManager) {
|
||||
handler := &ModelsHandler{
|
||||
vendorManager: vendorManager,
|
||||
}
|
||||
|
||||
r.GET("/models/names", handler.GetModelNames)
|
||||
}
|
||||
|
||||
func (h *ModelsHandler) GetModelNames(c *gin.Context) {
|
||||
vendorsModels, err := h.vendorManager.GetModels()
|
||||
if err != nil {
|
||||
c.JSON(500, gin.H{"error": "Server failed to retrieve model names"})
|
||||
return
|
||||
}
|
||||
|
||||
response := make(map[string]interface{})
|
||||
vendors := make(map[string][]string)
|
||||
|
||||
for _, groupItems := range vendorsModels.GroupsItems {
|
||||
vendors[groupItems.Group] = groupItems.Items
|
||||
}
|
||||
|
||||
response["models"] = h.getAllModelNames(vendorsModels)
|
||||
response["vendors"] = vendors
|
||||
c.JSON(200, response)
|
||||
}
|
||||
|
||||
func (h *ModelsHandler) getAllModelNames(vendorsModels *ai.VendorsModels) []string {
|
||||
var allModelNames []string
|
||||
for _, groupItems := range vendorsModels.GroupsItems {
|
||||
allModelNames = append(allModelNames, groupItems.Items...)
|
||||
}
|
||||
return allModelNames
|
||||
}
|
||||
275
restapi/ollama.go
Normal file
275
restapi/ollama.go
Normal file
@@ -0,0 +1,275 @@
|
||||
package restapi
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"github.com/danielmiessler/fabric/core"
|
||||
"github.com/gin-gonic/gin"
|
||||
"io"
|
||||
"log"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
type OllamaModel struct {
|
||||
Models []Model `json:"models"`
|
||||
}
|
||||
type Model struct {
|
||||
Details ModelDetails `json:"details"`
|
||||
Digest string `json:"digest"`
|
||||
Model string `json:"model"`
|
||||
ModifiedAt string `json:"modified_at"`
|
||||
Name string `json:"name"`
|
||||
Size int64 `json:"size"`
|
||||
}
|
||||
|
||||
type ModelDetails struct {
|
||||
Families []string `json:"families"`
|
||||
Family string `json:"family"`
|
||||
Format string `json:"format"`
|
||||
ParameterSize string `json:"parameter_size"`
|
||||
ParentModel string `json:"parent_model"`
|
||||
QuantizationLevel string `json:"quantization_level"`
|
||||
}
|
||||
|
||||
type APIConvert struct {
|
||||
registry *core.PluginRegistry
|
||||
r *gin.Engine
|
||||
addr *string
|
||||
}
|
||||
|
||||
type OllamaRequestBody struct {
|
||||
Messages []OllamaMessage `json:"messages"`
|
||||
Model string `json:"model"`
|
||||
Options struct {
|
||||
} `json:"options"`
|
||||
Stream bool `json:"stream"`
|
||||
}
|
||||
|
||||
type OllamaMessage struct {
|
||||
Content string `json:"content"`
|
||||
Role string `json:"role"`
|
||||
}
|
||||
|
||||
type OllamaResponse struct {
|
||||
Model string `json:"model"`
|
||||
CreatedAt string `json:"created_at"`
|
||||
Message struct {
|
||||
Role string `json:"role"`
|
||||
Content string `json:"content"`
|
||||
} `json:"message"`
|
||||
DoneReason string `json:"done_reason,omitempty"`
|
||||
Done bool `json:"done"`
|
||||
TotalDuration int64 `json:"total_duration,omitempty"`
|
||||
LoadDuration int `json:"load_duration,omitempty"`
|
||||
PromptEvalCount int `json:"prompt_eval_count,omitempty"`
|
||||
PromptEvalDuration int `json:"prompt_eval_duration,omitempty"`
|
||||
EvalCount int `json:"eval_count,omitempty"`
|
||||
EvalDuration int64 `json:"eval_duration,omitempty"`
|
||||
}
|
||||
|
||||
type FabricResponseFormat struct {
|
||||
Type string `json:"type"`
|
||||
Format string `json:"format"`
|
||||
Content string `json:"content"`
|
||||
}
|
||||
|
||||
func ServeOllama(registry *core.PluginRegistry, address string, version string) (err error) {
|
||||
r := gin.New()
|
||||
|
||||
// Middleware
|
||||
r.Use(gin.Logger())
|
||||
r.Use(gin.Recovery())
|
||||
|
||||
// Register routes
|
||||
fabricDb := registry.Db
|
||||
NewPatternsHandler(r, fabricDb.Patterns)
|
||||
NewContextsHandler(r, fabricDb.Contexts)
|
||||
NewSessionsHandler(r, fabricDb.Sessions)
|
||||
NewChatHandler(r, registry, fabricDb)
|
||||
NewConfigHandler(r, fabricDb)
|
||||
NewModelsHandler(r, registry.VendorManager)
|
||||
|
||||
typeConversion := APIConvert{
|
||||
registry: registry,
|
||||
r: r,
|
||||
addr: &address,
|
||||
}
|
||||
// Ollama Endpoints
|
||||
r.GET("/api/tags", typeConversion.ollamaTags)
|
||||
r.GET("/api/version", func(c *gin.Context) {
|
||||
c.Data(200, "application/json", []byte(fmt.Sprintf("{\"%s\"}", version)))
|
||||
return
|
||||
})
|
||||
r.POST("/api/chat", typeConversion.ollamaChat)
|
||||
|
||||
// Start server
|
||||
err = r.Run(address)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
func (f APIConvert) ollamaTags(c *gin.Context) {
|
||||
patterns, err := f.registry.Db.Patterns.GetNames()
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err})
|
||||
return
|
||||
}
|
||||
var response OllamaModel
|
||||
for _, pattern := range patterns {
|
||||
today := time.Now().Format("2024-11-25T12:07:58.915991813-05:00")
|
||||
details := ModelDetails{
|
||||
Families: []string{"fabric"},
|
||||
Family: "fabric",
|
||||
Format: "custom",
|
||||
ParameterSize: "42.0B",
|
||||
ParentModel: "",
|
||||
QuantizationLevel: "",
|
||||
}
|
||||
response.Models = append(response.Models, Model{
|
||||
Details: details,
|
||||
Digest: "365c0bd3c000a25d28ddbf732fe1c6add414de7275464c4e4d1c3b5fcb5d8ad1",
|
||||
Model: fmt.Sprintf("%s:latest", pattern),
|
||||
ModifiedAt: today,
|
||||
Name: fmt.Sprintf("%s:latest", pattern),
|
||||
Size: 0,
|
||||
})
|
||||
}
|
||||
|
||||
c.JSON(200, response)
|
||||
|
||||
}
|
||||
|
||||
func (f APIConvert) ollamaChat(c *gin.Context) {
|
||||
body, err := io.ReadAll(c.Request.Body)
|
||||
if err != nil {
|
||||
log.Printf("Error reading body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "testing endpoint"})
|
||||
return
|
||||
}
|
||||
var prompt OllamaRequestBody
|
||||
err = json.Unmarshal(body, &prompt)
|
||||
if err != nil {
|
||||
log.Printf("Error unmarshalling body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "testing endpoint"})
|
||||
return
|
||||
}
|
||||
now := time.Now()
|
||||
var chat ChatRequest
|
||||
|
||||
if len(prompt.Messages) == 1 {
|
||||
chat.Prompts = []PromptRequest{{
|
||||
UserInput: prompt.Messages[0].Content,
|
||||
Vendor: "",
|
||||
Model: "",
|
||||
ContextName: "",
|
||||
PatternName: strings.Split(prompt.Model, ":")[0],
|
||||
}}
|
||||
} else if len(prompt.Messages) > 1 {
|
||||
var content string
|
||||
for _, msg := range prompt.Messages {
|
||||
content = fmt.Sprintf("%s%s:%s\n", content, msg.Role, msg.Content)
|
||||
}
|
||||
chat.Prompts = []PromptRequest{{
|
||||
UserInput: content,
|
||||
Vendor: "",
|
||||
Model: "",
|
||||
ContextName: "",
|
||||
PatternName: strings.Split(prompt.Model, ":")[0],
|
||||
}}
|
||||
}
|
||||
fabricChatReq, err := json.Marshal(chat)
|
||||
if err != nil {
|
||||
log.Printf("Error marshalling body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err})
|
||||
return
|
||||
}
|
||||
ctx := context.Background()
|
||||
var req *http.Request
|
||||
if strings.Contains(*f.addr, "http") {
|
||||
req, err = http.NewRequest("POST", fmt.Sprintf("%s/chat", *f.addr), bytes.NewBuffer(fabricChatReq))
|
||||
} else {
|
||||
req, err = http.NewRequest("POST", fmt.Sprintf("http://127.0.0.1%s/chat", *f.addr), bytes.NewBuffer(fabricChatReq))
|
||||
}
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
req = req.WithContext(ctx)
|
||||
|
||||
fabricRes, err := http.DefaultClient.Do(req)
|
||||
if err != nil {
|
||||
log.Printf("Error getting /chat body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err})
|
||||
return
|
||||
}
|
||||
body, err = io.ReadAll(fabricRes.Body)
|
||||
if err != nil {
|
||||
log.Printf("Error reading body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "testing endpoint"})
|
||||
return
|
||||
}
|
||||
var forwardedResponse OllamaResponse
|
||||
var forwardedResponses []OllamaResponse
|
||||
var fabricResponse FabricResponseFormat
|
||||
err = json.Unmarshal([]byte(strings.Split(strings.Split(string(body), "\n")[0], "data: ")[1]), &fabricResponse)
|
||||
if err != nil {
|
||||
log.Printf("Error unmarshalling body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": "testing endpoint"})
|
||||
return
|
||||
}
|
||||
for _, word := range strings.Split(fabricResponse.Content, " ") {
|
||||
forwardedResponse = OllamaResponse{
|
||||
Model: "",
|
||||
CreatedAt: "",
|
||||
Message: struct {
|
||||
Role string `json:"role"`
|
||||
Content string `json:"content"`
|
||||
}(struct {
|
||||
Role string
|
||||
Content string
|
||||
}{Content: fmt.Sprintf("%s ", word), Role: "assistant"}),
|
||||
Done: false,
|
||||
}
|
||||
forwardedResponses = append(forwardedResponses, forwardedResponse)
|
||||
}
|
||||
forwardedResponse.Model = prompt.Model
|
||||
forwardedResponse.CreatedAt = time.Now().UTC().Format("2006-01-02T15:04:05.999999999Z")
|
||||
forwardedResponse.Message.Role = "assistant"
|
||||
forwardedResponse.Message.Content = ""
|
||||
forwardedResponse.DoneReason = "stop"
|
||||
forwardedResponse.Done = true
|
||||
forwardedResponse.TotalDuration = time.Since(now).Nanoseconds()
|
||||
forwardedResponse.LoadDuration = int(time.Since(now).Nanoseconds())
|
||||
forwardedResponse.PromptEvalCount = 42
|
||||
forwardedResponse.PromptEvalDuration = int(time.Since(now).Nanoseconds())
|
||||
forwardedResponse.EvalCount = 420
|
||||
forwardedResponse.EvalDuration = time.Since(now).Nanoseconds()
|
||||
forwardedResponses = append(forwardedResponses, forwardedResponse)
|
||||
|
||||
var res []byte
|
||||
for _, response := range forwardedResponses {
|
||||
marshalled, err := json.Marshal(response)
|
||||
if err != nil {
|
||||
log.Printf("Error marshalling body: %v", err)
|
||||
c.JSON(http.StatusInternalServerError, gin.H{"error": err})
|
||||
return
|
||||
}
|
||||
for _, bytein := range marshalled {
|
||||
res = append(res, bytein)
|
||||
}
|
||||
for _, bytebreak := range []byte("\n") {
|
||||
res = append(res, bytebreak)
|
||||
}
|
||||
}
|
||||
c.Data(200, "application/json", res)
|
||||
|
||||
//c.JSON(200, forwardedResponse)
|
||||
return
|
||||
}
|
||||
@@ -27,7 +27,7 @@ func NewPatternsHandler(r *gin.Engine, patterns *fsdb.PatternsEntity) (ret *Patt
|
||||
func (h *PatternsHandler) Get(c *gin.Context) {
|
||||
name := c.Param("name")
|
||||
variables := make(map[string]string) // Assuming variables are passed somehow
|
||||
input := "" // Assuming input is passed somehow
|
||||
input := "" // Assuming input is passed somehow
|
||||
pattern, err := h.patterns.GetApplyVariables(name, variables, input)
|
||||
if err != nil {
|
||||
c.JSON(http.StatusInternalServerError, err.Error())
|
||||
|
||||
@@ -17,6 +17,9 @@ func Serve(registry *core.PluginRegistry, address string) (err error) {
|
||||
NewPatternsHandler(r, fabricDb.Patterns)
|
||||
NewContextsHandler(r, fabricDb.Contexts)
|
||||
NewSessionsHandler(r, fabricDb.Sessions)
|
||||
NewChatHandler(r, registry, fabricDb)
|
||||
NewConfigHandler(r, fabricDb)
|
||||
NewModelsHandler(r, registry.VendorManager)
|
||||
|
||||
// Start server
|
||||
err = r.Run(address)
|
||||
|
||||
1737
streamlit.py
Normal file
1737
streamlit.py
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,3 @@
|
||||
package main
|
||||
|
||||
var version = "v1.4.109"
|
||||
var version = "v1.4.128"
|
||||
|
||||
11
web/.github/dependabot.yml
vendored
Normal file
11
web/.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "npm", "pnpm" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
0
web/.npmrc
Normal file
0
web/.npmrc
Normal file
4
web/.prettierignore
Normal file
4
web/.prettierignore
Normal file
@@ -0,0 +1,4 @@
|
||||
# Package Managers
|
||||
package-lock.json
|
||||
pnpm-lock.yaml
|
||||
yarn.lock
|
||||
8
web/.prettierrc
Normal file
8
web/.prettierrc
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"useTabs": true,
|
||||
"singleQuote": true,
|
||||
"trailingComma": "none",
|
||||
"printWidth": 100,
|
||||
"plugins": ["prettier-plugin-svelte"],
|
||||
"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
|
||||
}
|
||||
120
web/.vscode/settings.json
vendored
Normal file
120
web/.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,120 @@
|
||||
{
|
||||
"prettier.documentSelectors": [
|
||||
"**/*.svelte"
|
||||
],
|
||||
"tailwindCSS.classAttributes": [
|
||||
"class",
|
||||
"accent",
|
||||
"active",
|
||||
"animIndeterminate",
|
||||
"aspectRatio",
|
||||
"background",
|
||||
"badge",
|
||||
"bgBackdrop",
|
||||
"bgDark",
|
||||
"bgDrawer",
|
||||
"bgLight",
|
||||
"blur",
|
||||
"border",
|
||||
"button",
|
||||
"buttonAction",
|
||||
"buttonBack",
|
||||
"buttonClasses",
|
||||
"buttonComplete",
|
||||
"buttonDismiss",
|
||||
"buttonNeutral",
|
||||
"buttonNext",
|
||||
"buttonPositive",
|
||||
"buttonTextCancel",
|
||||
"buttonTextConfirm",
|
||||
"buttonTextFirst",
|
||||
"buttonTextLast",
|
||||
"buttonTextNext",
|
||||
"buttonTextPrevious",
|
||||
"buttonTextSubmit",
|
||||
"caretClosed",
|
||||
"caretOpen",
|
||||
"chips",
|
||||
"color",
|
||||
"controlSeparator",
|
||||
"controlVariant",
|
||||
"cursor",
|
||||
"display",
|
||||
"element",
|
||||
"fill",
|
||||
"fillDark",
|
||||
"fillLight",
|
||||
"flex",
|
||||
"flexDirection",
|
||||
"gap",
|
||||
"gridColumns",
|
||||
"height",
|
||||
"hover",
|
||||
"inactive",
|
||||
"indent",
|
||||
"justify",
|
||||
"meter",
|
||||
"padding",
|
||||
"position",
|
||||
"regionAnchor",
|
||||
"regionBackdrop",
|
||||
"regionBody",
|
||||
"regionCaption",
|
||||
"regionCaret",
|
||||
"regionCell",
|
||||
"regionChildren",
|
||||
"regionChipList",
|
||||
"regionChipWrapper",
|
||||
"regionCone",
|
||||
"regionContent",
|
||||
"regionControl",
|
||||
"regionDefault",
|
||||
"regionDrawer",
|
||||
"regionFoot",
|
||||
"regionFootCell",
|
||||
"regionFooter",
|
||||
"regionHead",
|
||||
"regionHeadCell",
|
||||
"regionHeader",
|
||||
"regionIcon",
|
||||
"regionInput",
|
||||
"regionInterface",
|
||||
"regionInterfaceText",
|
||||
"regionLabel",
|
||||
"regionLead",
|
||||
"regionLegend",
|
||||
"regionList",
|
||||
"regionListItem",
|
||||
"regionNavigation",
|
||||
"regionPage",
|
||||
"regionPanel",
|
||||
"regionRowHeadline",
|
||||
"regionRowMain",
|
||||
"regionSummary",
|
||||
"regionSymbol",
|
||||
"regionTab",
|
||||
"regionTrail",
|
||||
"ring",
|
||||
"rounded",
|
||||
"select",
|
||||
"shadow",
|
||||
"slotDefault",
|
||||
"slotFooter",
|
||||
"slotHeader",
|
||||
"slotLead",
|
||||
"slotMessage",
|
||||
"slotMeta",
|
||||
"slotPageContent",
|
||||
"slotPageFooter",
|
||||
"slotPageHeader",
|
||||
"slotSidebarLeft",
|
||||
"slotSidebarRight",
|
||||
"slotTrail",
|
||||
"spacing",
|
||||
"text",
|
||||
"track",
|
||||
"transition",
|
||||
"width",
|
||||
"zIndex"
|
||||
]
|
||||
}
|
||||
13
web/README.md
Normal file
13
web/README.md
Normal file
@@ -0,0 +1,13 @@
|
||||
## The Fabric Web App
|
||||
[Installing](#Installing)|[Todos](#Todos)|[Collaborators](#Collaborators)
|
||||
|
||||
This is the web app for Fabric. It is built using [Svelte](https://svelte.dev/), [SkeletonUI](https://skeleton.dev/), and [Mdsvex](https://mdsvex.pngwn.io/).
|
||||
|
||||
The goal of this app is to not only provide a user interface for Fabric, but also a out-of-the-box website for those who want to get started with web development or blogging. The tech stack is minimal and (I hope) the code is easy to read and understand. One thing I kept in mind when making this app was to make it easy for beginners to get started with web development. You can use this app as a GUI interface for Fabric, a ready to go blog-site, or a website template for your own projects. I hope you find it useful!
|
||||
|
||||

|
||||
|
||||
### Installing
|
||||
It can be installed by navigating to the `web` directory and using `npm install`, `pnpm install`, or your favorite package manager. Then simply run `npm run dev` or your equivalent command to start the app. *You will need to run fabric in a seperate terminal with the `fabric --serve` command.*
|
||||
|
||||
|
||||
21
web/SECURITY.md
Normal file
21
web/SECURITY.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Use this section to tell people about which versions of your project are
|
||||
currently being supported with security updates.
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 5.1.x | :white_check_mark: |
|
||||
| 5.0.x | :x: |
|
||||
| 4.0.x | :white_check_mark: |
|
||||
| < 4.0 | :x: |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Use this section to tell people how to report a vulnerability.
|
||||
|
||||
Tell them where to go, how often they can expect to get an update on a
|
||||
reported vulnerability, what to expect if the vulnerability is accepted or
|
||||
declined, etc.
|
||||
38
web/STD-README.md
Normal file
38
web/STD-README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# create-svelte
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
|
||||
|
||||
## Creating a project
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
|
||||
```bash
|
||||
# create a new project in the current directory
|
||||
npm create svelte@latest
|
||||
|
||||
# create a new project in my-app
|
||||
npm create svelte@latest my-app
|
||||
```
|
||||
|
||||
## Developing
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
To create a production version of your app:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
|
||||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
|
||||
32
web/eslint.config.js
Normal file
32
web/eslint.config.js
Normal file
@@ -0,0 +1,32 @@
|
||||
import eslint from '@eslint/js';
|
||||
import prettier from 'eslint-config-prettier';
|
||||
import svelte from 'eslint-plugin-svelte';
|
||||
import globals from 'globals';
|
||||
import tseslint from 'typescript-eslint';
|
||||
|
||||
export default tseslint.config(
|
||||
eslint.configs.recommended,
|
||||
...tseslint.configs.recommended,
|
||||
...svelte.configs['flat/recommended'],
|
||||
prettier,
|
||||
...svelte.configs['flat/prettier'],
|
||||
{
|
||||
languageOptions: {
|
||||
globals: {
|
||||
...globals.browser,
|
||||
...globals.node
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
files: ['**/*.svelte'],
|
||||
languageOptions: {
|
||||
parserOptions: {
|
||||
parser: tseslint.parser
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
ignores: ['build/', '.svelte-kit/', 'dist/']
|
||||
}
|
||||
);
|
||||
19
web/jsconfig.json
Normal file
19
web/jsconfig.json
Normal file
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"extends": "./.svelte-kit/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"allowJs": true,
|
||||
"checkJs": true,
|
||||
"esModuleInterop": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"resolveJsonModule": true,
|
||||
"skipLibCheck": true,
|
||||
"sourceMap": true,
|
||||
"strict": true,
|
||||
"moduleResolution": "bundler"
|
||||
}
|
||||
// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
|
||||
// except $lib which is handled by https://kit.svelte.dev/docs/configuration#files
|
||||
//
|
||||
// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
|
||||
// from the referenced tsconfig.json - TypeScript does not merge them in
|
||||
}
|
||||
4
web/markdown.d.ts
vendored
Normal file
4
web/markdown.d.ts
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
/* declare module '*.md' {
|
||||
const component: import('svelte').ComponentType;
|
||||
export default component;
|
||||
} */
|
||||
102
web/my-custom-theme.ts
Normal file
102
web/my-custom-theme.ts
Normal file
@@ -0,0 +1,102 @@
|
||||
|
||||
import type { CustomThemeConfig } from '@skeletonlabs/tw-plugin';
|
||||
|
||||
export const myCustomTheme: CustomThemeConfig = {
|
||||
name: 'my-custom-theme',
|
||||
properties: {
|
||||
// =~= Theme Properties =~=
|
||||
"--theme-font-family-base": `system-ui`,
|
||||
"--theme-font-family-heading": `system-ui`,
|
||||
"--theme-font-color-base": "var(--color-primary-800)",
|
||||
"--theme-font-color-dark": "var(--color-primary-300)",
|
||||
"--theme-rounded-base": "9999px",
|
||||
"--theme-rounded-container": "8px",
|
||||
"--theme-border-base": "1px",
|
||||
// =~= Theme On-X Colors =~=
|
||||
"--on-primary": "0 0 0",
|
||||
"--on-secondary": "0 0 0",
|
||||
"--on-tertiary": "0 0 0",
|
||||
"--on-success": "0 0 0",
|
||||
"--on-warning": "0 0 0",
|
||||
"--on-error": "0 0 0",
|
||||
"--on-surface": "0 0 0",
|
||||
// =~= Theme Colors =~=
|
||||
// primary | #613bf7
|
||||
"--color-primary-50": "231 226 254", // #e7e2fe
|
||||
"--color-primary-100": "223 216 253", // #dfd8fd
|
||||
"--color-primary-200": "216 206 253", // #d8cefd
|
||||
"--color-primary-300": "192 177 252", // #c0b1fc
|
||||
"--color-primary-400": "144 118 249", // #9076f9
|
||||
"--color-primary-500": "97 59 247", // #613bf7
|
||||
"--color-primary-600": "87 53 222", // #5735de
|
||||
"--color-primary-700": "73 44 185", // #492cb9
|
||||
"--color-primary-800": "58 35 148", // #3a2394
|
||||
"--color-primary-900": "48 29 121", // #301d79
|
||||
// secondary | #9de1ae
|
||||
"--color-secondary-50": "240 251 243", // #f0fbf3
|
||||
"--color-secondary-100": "235 249 239", // #ebf9ef
|
||||
"--color-secondary-200": "231 248 235", // #e7f8eb
|
||||
"--color-secondary-300": "216 243 223", // #d8f3df
|
||||
"--color-secondary-400": "186 234 198", // #baeac6
|
||||
"--color-secondary-500": "157 225 174", // #9de1ae
|
||||
"--color-secondary-600": "141 203 157", // #8dcb9d
|
||||
"--color-secondary-700": "118 169 131", // #76a983
|
||||
"--color-secondary-800": "94 135 104", // #5e8768
|
||||
"--color-secondary-900": "77 110 85", // #4d6e55
|
||||
// tertiary | #3fa0a6
|
||||
"--color-tertiary-50": "226 241 242", // #e2f1f2
|
||||
"--color-tertiary-100": "217 236 237", // #d9eced
|
||||
"--color-tertiary-200": "207 231 233", // #cfe7e9
|
||||
"--color-tertiary-300": "178 217 219", // #b2d9db
|
||||
"--color-tertiary-400": "121 189 193", // #79bdc1
|
||||
"--color-tertiary-500": "63 160 166", // #3fa0a6
|
||||
"--color-tertiary-600": "57 144 149", // #399095
|
||||
"--color-tertiary-700": "47 120 125", // #2f787d
|
||||
"--color-tertiary-800": "38 96 100", // #266064
|
||||
"--color-tertiary-900": "31 78 81", // #1f4e51
|
||||
// success | #37b3fc
|
||||
"--color-success-50": "225 244 255", // #e1f4ff
|
||||
"--color-success-100": "215 240 254", // #d7f0fe
|
||||
"--color-success-200": "205 236 254", // #cdecfe
|
||||
"--color-success-300": "175 225 254", // #afe1fe
|
||||
"--color-success-400": "115 202 253", // #73cafd
|
||||
"--color-success-500": "55 179 252", // #37b3fc
|
||||
"--color-success-600": "50 161 227", // #32a1e3
|
||||
"--color-success-700": "41 134 189", // #2986bd
|
||||
"--color-success-800": "33 107 151", // #216b97
|
||||
"--color-success-900": "27 88 123", // #1b587b
|
||||
// warning | #d209f8
|
||||
"--color-warning-50": "248 218 254", // #f8dafe
|
||||
"--color-warning-100": "246 206 254", // #f6cefe
|
||||
"--color-warning-200": "244 194 253", // #f4c2fd
|
||||
"--color-warning-300": "237 157 252", // #ed9dfc
|
||||
"--color-warning-400": "224 83 250", // #e053fa
|
||||
"--color-warning-500": "210 9 248", // #d209f8
|
||||
"--color-warning-600": "189 8 223", // #bd08df
|
||||
"--color-warning-700": "158 7 186", // #9e07ba
|
||||
"--color-warning-800": "126 5 149", // #7e0595
|
||||
"--color-warning-900": "103 4 122", // #67047a
|
||||
// error | #90df16
|
||||
"--color-error-50": "238 250 220", // #eefadc
|
||||
"--color-error-100": "233 249 208", // #e9f9d0
|
||||
"--color-error-200": "227 247 197", // #e3f7c5
|
||||
"--color-error-300": "211 242 162", // #d3f2a2
|
||||
"--color-error-400": "177 233 92", // #b1e95c
|
||||
"--color-error-500": "144 223 22", // #90df16
|
||||
"--color-error-600": "130 201 20", // #82c914
|
||||
"--color-error-700": "108 167 17", // #6ca711
|
||||
"--color-error-800": "86 134 13", // #56860d
|
||||
"--color-error-900": "71 109 11", // #476d0b
|
||||
// surface | #46a1ed
|
||||
"--color-surface-50": "227 241 252", // #e3f1fc
|
||||
"--color-surface-100": "218 236 251", // #daecfb
|
||||
"--color-surface-200": "209 232 251", // #d1e8fb
|
||||
"--color-surface-300": "181 217 248", // #b5d9f8
|
||||
"--color-surface-400": "126 189 242", // #7ebdf2
|
||||
"--color-surface-500": "70 161 237", // #46a1ed
|
||||
"--color-surface-600": "63 145 213", // #3f91d5
|
||||
"--color-surface-700": "53 121 178", // #3579b2
|
||||
"--color-surface-800": "42 97 142", // #2a618e
|
||||
"--color-surface-900": "34 79 116", // #224f74
|
||||
}
|
||||
}
|
||||
7397
web/package-lock.json
generated
Normal file
7397
web/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
53
web/package.json
Normal file
53
web/package.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"name": "terminal-blog",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "vite dev",
|
||||
"build": "vite build",
|
||||
"preview": "vite preview",
|
||||
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
|
||||
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
|
||||
"test": "vitest",
|
||||
"lint": "prettier --check . && eslint .",
|
||||
"format": "prettier --write ."
|
||||
},
|
||||
"devDependencies": {
|
||||
"@skeletonlabs/skeleton": "^2.8.0",
|
||||
"@skeletonlabs/tw-plugin": "^0.3.1",
|
||||
"@sveltejs/adapter-auto": "^3.0.0",
|
||||
"@sveltejs/kit": "^2.8.4",
|
||||
"@sveltejs/vite-plugin-svelte": "^3.0.0",
|
||||
"@tailwindcss/forms": "^0.5.7",
|
||||
"@tailwindcss/typography": "^0.5.10",
|
||||
"@types/node": "^20.10.0",
|
||||
"autoprefixer": "^10.4.16",
|
||||
"lucide-svelte": "^0.309.0",
|
||||
"mdsvex": "^0.11.0",
|
||||
"postcss": "^8.4.32",
|
||||
"postcss-load-config": "^5.0.2",
|
||||
"svelte": "^4.2.7",
|
||||
"svelte-check": "^3.6.0",
|
||||
"svelte-youtube-embed": "^0.3.3",
|
||||
"tailwindcss": "^3.3.6",
|
||||
"typescript": "^5.0.0",
|
||||
"vite": "^5.0.3",
|
||||
"vite-plugin-tailwind-purgecss": "^0.2.0"
|
||||
},
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"@floating-ui/dom": "^1.5.3",
|
||||
"clsx": "^2.1.1",
|
||||
"cn": "^0.1.1",
|
||||
"date-fns": "^4.1.0",
|
||||
"highlight.js": "^11.10.0",
|
||||
"marked": "^15.0.1",
|
||||
"rehype": "^13.0.2",
|
||||
"rehype-autolink-headings": "^7.1.0",
|
||||
"rehype-external-links": "^3.0.0",
|
||||
"rehype-slug": "^6.0.0",
|
||||
"rehype-unwrap-images": "^1.0.0",
|
||||
"tailwind-merge": "^2.5.4",
|
||||
"youtube-transcript": "^1.2.1"
|
||||
}
|
||||
}
|
||||
2925
web/pnpm-lock.yaml
generated
Normal file
2925
web/pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
6
web/postcss.config.cjs
Normal file
6
web/postcss.config.cjs
Normal file
@@ -0,0 +1,6 @@
|
||||
module.exports = {
|
||||
plugins: {
|
||||
tailwindcss: {},
|
||||
autoprefixer: {},
|
||||
},
|
||||
}
|
||||
6
web/postcss.config.js
Normal file
6
web/postcss.config.js
Normal file
@@ -0,0 +1,6 @@
|
||||
export default {
|
||||
plugins: {
|
||||
tailwindcss: {},
|
||||
autoprefixer: {}
|
||||
}
|
||||
};
|
||||
22
web/rollup.config.js
Normal file
22
web/rollup.config.js
Normal file
@@ -0,0 +1,22 @@
|
||||
import svelte from 'rollup-plugin-svelte';
|
||||
import resolve from '@rollup/plugin-node-resolve';
|
||||
|
||||
export default {
|
||||
input: 'src/+page.js',
|
||||
output: {
|
||||
file: 'public/bundle.js',
|
||||
format: 'iife',
|
||||
name: 'app'
|
||||
},
|
||||
plugins: [
|
||||
svelte({
|
||||
// svelte options
|
||||
extensions: [".svelte", ".svx", ".md"],
|
||||
preprocess: mdsvex()
|
||||
}),
|
||||
resolve({
|
||||
browser: true,
|
||||
dedupe: ['svelte']
|
||||
})
|
||||
]
|
||||
};
|
||||
134
web/src/app.css
Normal file
134
web/src/app.css
Normal file
@@ -0,0 +1,134 @@
|
||||
/* @tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
|
||||
:root {
|
||||
--font-body: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu,
|
||||
Cantarell, 'Go Mono', 'Fira Sans', 'Helvetica Neue', sans-serif;
|
||||
--font-mono: 'Fira Code', monospace;
|
||||
--column-width: 42rem;
|
||||
--column-margin-top: 4rem;
|
||||
} */
|
||||
|
||||
/* Light theme variables */
|
||||
/* :root {
|
||||
--background: hsl(249, 81%, 85%);
|
||||
--foreground: hsl(229, 65%, 29%);
|
||||
--card: 0 0% 100%;
|
||||
--card-foreground: 224 71.4% 4.1%;
|
||||
--popover: 0 0% 100%;
|
||||
--popover-foreground: 224 71.4% 4.1%;
|
||||
--primary: hsl(262.1 83.3% 57.8%);
|
||||
--primary-foreground: hsl(274, 100%, 90%);
|
||||
--secondary: hsl(173, 74%, 68%);
|
||||
--secondary-foreground: hsl(195, 100%, 90%);
|
||||
--muted: 220 14.3% 95.9%;
|
||||
--muted-foreground: 220 8.9% 46.1%;
|
||||
--accent: hsl(220, 37%, 49%);
|
||||
--accent-foreground: 220.9 39.3% 11%;
|
||||
--destructive: 0 84.2% 60.2%;
|
||||
--destructive-foreground: 210 20% 98%;
|
||||
--border: 220 13% 91%;
|
||||
--input: 220 13% 91%;
|
||||
--ring: 262.1 83.3% 57.8%;
|
||||
--radius: 0.5rem;
|
||||
} */
|
||||
|
||||
/* Dark theme variables */
|
||||
/* .dark {
|
||||
--background: 224 71.4% 4.1%;
|
||||
--foreground: 210 20% 98%;
|
||||
--card: 224 71.4% 4.1%;
|
||||
--card-foreground: 210 20% 98%;
|
||||
--popover: 224 71.4% 4.1%;
|
||||
--popover-foreground: 210 20% 98%;
|
||||
--primary: 263.4 70% 50.4%;
|
||||
--primary-foreground: 210 20% 98%;
|
||||
--secondary: 215 27.9% 16.9%;
|
||||
--secondary-foreground: 210 20% 98%;
|
||||
--muted: 215 27.9% 16.9%;
|
||||
--muted-foreground: 217.9 10.6% 64.9%;
|
||||
--accent: 215 27.9% 16.9%;
|
||||
--accent-foreground: 210 20% 98%;
|
||||
--destructive: 0 62.8% 30.6%;
|
||||
--destructive-foreground: 210 20% 98%;
|
||||
--border: 215 27.9% 16.9%;
|
||||
--input: 215 27.9% 16.9%;
|
||||
--ring: 263.4 70% 50.4%;
|
||||
}
|
||||
|
||||
@layer base {
|
||||
* {
|
||||
@apply border-border;
|
||||
}
|
||||
body {
|
||||
@apply bg-background text-foreground;
|
||||
font-feature-settings: "rlig" 1, "calt" 1;
|
||||
} */
|
||||
|
||||
/* Enhanced Typography */
|
||||
/* h1, h2, h3, h4, h5, h6 {
|
||||
@apply font-semibold tracking-tight;
|
||||
}
|
||||
|
||||
h1 {
|
||||
@apply text-4xl lg:text-5xl;
|
||||
}
|
||||
|
||||
h2 {
|
||||
@apply text-3xl lg:text-4xl;
|
||||
}
|
||||
|
||||
h3 {
|
||||
@apply text-2xl lg:text-3xl;
|
||||
}
|
||||
|
||||
p {
|
||||
@apply leading-7;
|
||||
}
|
||||
*/
|
||||
/* Links */
|
||||
/* a {
|
||||
@apply text-primary hover:text-primary/80 transition-colors;
|
||||
} */
|
||||
|
||||
/* Code blocks */
|
||||
/* pre {
|
||||
@apply p-4 rounded-lg bg-muted/50 font-mono text-sm;
|
||||
}
|
||||
|
||||
code {
|
||||
@apply font-mono text-sm;
|
||||
}
|
||||
*/
|
||||
/* Terminal specific styles */
|
||||
/* .terminal-window {
|
||||
@apply rounded-lg border bg-card shadow-lg overflow-hidden;
|
||||
}
|
||||
|
||||
.terminal-text {
|
||||
@apply font-mono text-sm;
|
||||
}
|
||||
*/
|
||||
/* Form elements */
|
||||
/* input, textarea, select {
|
||||
@apply rounded-md border border-input bg-background px-3 py-2 text-sm ring-offset-background placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2;
|
||||
}
|
||||
|
||||
button {
|
||||
@apply inline-flex items-center justify-center rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2;
|
||||
}
|
||||
} */
|
||||
|
||||
/* Custom scrollbar */
|
||||
/* ::-webkit-scrollbar {
|
||||
@apply w-2;
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-track {
|
||||
@apply bg-muted;
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-thumb {
|
||||
@apply bg-muted-foreground/30 rounded-full hover:bg-muted-foreground/50 transition-colors;
|
||||
} */
|
||||
9
web/src/app.d.ts
vendored
Normal file
9
web/src/app.d.ts
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
// See https://kit.svelte.dev/docs/types#app
|
||||
// for information about these interfaces
|
||||
// and what to do when importing types
|
||||
declare namespace App {
|
||||
// interface Locals {}
|
||||
interface PageData {}
|
||||
// interface Error {}
|
||||
// interface Platform {}
|
||||
}
|
||||
12
web/src/app.html
Normal file
12
web/src/app.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" class="dark">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<link rel="icon" href="%sveltekit.assets%/favicon.png" />
|
||||
<meta name="viewport" content="width=device-width" />
|
||||
%sveltekit.head%
|
||||
</head>
|
||||
<body data-sveltekit-preload-data="hover" data-theme="my-custom-theme">
|
||||
<div style="display: contents" class="h-full overflow-hidden">%sveltekit.body%</div>
|
||||
</body>
|
||||
</html>
|
||||
25
web/src/app.postcss
Normal file
25
web/src/app.postcss
Normal file
@@ -0,0 +1,25 @@
|
||||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
@tailwind variants;
|
||||
|
||||
html,
|
||||
body {
|
||||
@apply h-full overflow-hidden;
|
||||
}
|
||||
|
||||
.terminal-output {
|
||||
@apply font-mono text-sm;
|
||||
}
|
||||
|
||||
.terminal-input {
|
||||
@apply font-mono text-sm;
|
||||
}
|
||||
|
||||
/* Skeleton theme overrides */
|
||||
:root [data-theme='skeleton'] {
|
||||
--theme-font-family-base: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen,
|
||||
Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
|
||||
--theme-font-family-heading: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
|
||||
Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user