Compare commits

..

4 Commits

Author SHA1 Message Date
597711350a fix script startup and validate with tests
Some checks failed
Go / build (push) Has been cancelled
Go / release (push) Has been cancelled
2025-11-10 12:36:55 +00:00
7113848de8 fix error handling of default policy script
Some checks failed
Go / build (push) Has been cancelled
Go / release (push) Has been cancelled
2025-11-10 11:55:42 +00:00
54606c6318 curl|bash deploy script 2025-11-10 11:42:59 +00:00
09bcbac20d create concurrent script runner per rule script
Some checks failed
Go / build (push) Has been cancelled
Go / release (push) Has been cancelled
bump to v0.27.1
2025-11-10 10:56:02 +00:00
7 changed files with 1151 additions and 476 deletions

View File

@@ -29,7 +29,10 @@
"Bash(CGO_ENABLED=0 go build:*)",
"Bash(CGO_ENABLED=0 go test:*)",
"Bash(app/web/dist/index.html)",
"Bash(export CGO_ENABLED=0)"
"Bash(export CGO_ENABLED=0)",
"Bash(bash:*)",
"Bash(CGO_ENABLED=0 ORLY_LOG_LEVEL=debug go test:*)",
"Bash(/tmp/test-policy-script.sh)"
],
"deny": [],
"ask": []

View File

@@ -104,21 +104,25 @@ done
b.Fatalf("Failed to create test script: %v", err)
}
ctx := context.Background()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
manager := &PolicyManager{
ctx: ctx,
configDir: tempDir,
scriptPath: scriptPath,
enabled: true,
responseChan: make(chan PolicyResponse, 100),
ctx: ctx,
cancel: cancel,
configDir: tempDir,
scriptPath: scriptPath,
enabled: true,
runners: make(map[string]*ScriptRunner),
}
// Start the policy manager
err = manager.StartPolicy()
// Get or create runner and start it
runner := manager.getOrCreateRunner(scriptPath)
err = runner.Start()
if err != nil {
b.Fatalf("Failed to start policy: %v", err)
b.Fatalf("Failed to start policy script: %v", err)
}
defer manager.StopPolicy()
defer runner.Stop()
// Give the script time to start
time.Sleep(100 * time.Millisecond)

File diff suppressed because it is too large Load Diff

View File

@@ -715,12 +715,12 @@ func TestPolicyManagerLifecycle(t *testing.T) {
defer cancel()
manager := &PolicyManager{
ctx: ctx,
cancel: cancel,
configDir: "/tmp",
scriptPath: "/tmp/policy.sh",
enabled: true,
responseChan: make(chan PolicyResponse, 100),
ctx: ctx,
cancel: cancel,
configDir: "/tmp",
scriptPath: "/tmp/policy.sh",
enabled: true,
runners: make(map[string]*ScriptRunner),
}
// Test manager state
@@ -732,31 +732,37 @@ func TestPolicyManagerLifecycle(t *testing.T) {
t.Error("Expected policy manager to not be running initially")
}
// Test getting or creating a runner for a non-existent script
runner := manager.getOrCreateRunner("/tmp/policy.sh")
if runner == nil {
t.Fatal("Expected runner to be created")
}
// Test starting with non-existent script (should fail gracefully)
err := manager.StartPolicy()
err := runner.Start()
if err == nil {
t.Error("Expected error when starting policy with non-existent script")
t.Error("Expected error when starting script with non-existent file")
}
// Test stopping when not running (should fail gracefully)
err = manager.StopPolicy()
err = runner.Stop()
if err == nil {
t.Error("Expected error when stopping policy that's not running")
t.Error("Expected error when stopping script that's not running")
}
}
func TestPolicyManagerProcessEvent(t *testing.T) {
// Test processing event when manager is not running (should fail gracefully)
// Test processing event when runner is not running (should fail gracefully)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
manager := &PolicyManager{
ctx: ctx,
cancel: cancel,
configDir: "/tmp",
scriptPath: "/tmp/policy.sh",
enabled: true,
responseChan: make(chan PolicyResponse, 100),
ctx: ctx,
cancel: cancel,
configDir: "/tmp",
scriptPath: "/tmp/policy.sh",
enabled: true,
runners: make(map[string]*ScriptRunner),
}
// Generate real keypair for testing
@@ -772,10 +778,13 @@ func TestPolicyManagerProcessEvent(t *testing.T) {
IPAddress: "127.0.0.1",
}
// Get or create a runner
runner := manager.getOrCreateRunner("/tmp/policy.sh")
// Process event when not running (should fail gracefully)
_, err := manager.ProcessEvent(policyEvent)
_, err := runner.ProcessEvent(policyEvent)
if err == nil {
t.Error("Expected error when processing event with non-running policy manager")
t.Error("Expected error when processing event with non-running script")
}
}
@@ -886,43 +895,53 @@ func TestEdgeCasesManagerWithInvalidScript(t *testing.T) {
t.Fatalf("Failed to create invalid script: %v", err)
}
ctx := context.Background()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
manager := &PolicyManager{
ctx: ctx,
configDir: tempDir,
scriptPath: scriptPath,
enabled: true,
responseChan: make(chan PolicyResponse, 100),
ctx: ctx,
cancel: cancel,
configDir: tempDir,
scriptPath: scriptPath,
enabled: true,
runners: make(map[string]*ScriptRunner),
}
// Should fail to start with invalid script
err = manager.StartPolicy()
// Get runner and try to start with invalid script
runner := manager.getOrCreateRunner(scriptPath)
err = runner.Start()
if err == nil {
t.Error("Expected error when starting policy with invalid script")
t.Error("Expected error when starting invalid script")
}
}
func TestEdgeCasesManagerDoubleStart(t *testing.T) {
// Test double start without actually starting (simpler test)
ctx := context.Background()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
manager := &PolicyManager{
ctx: ctx,
configDir: "/tmp",
scriptPath: "/tmp/policy.sh",
enabled: true,
responseChan: make(chan PolicyResponse, 100),
ctx: ctx,
cancel: cancel,
configDir: "/tmp",
scriptPath: "/tmp/policy.sh",
enabled: true,
runners: make(map[string]*ScriptRunner),
}
// Get runner
runner := manager.getOrCreateRunner("/tmp/policy.sh")
// Try to start with non-existent script - should fail
err := manager.StartPolicy()
err := runner.Start()
if err == nil {
t.Error("Expected error when starting policy manager with non-existent script")
t.Error("Expected error when starting script with non-existent file")
}
// Try to start again - should still fail
err = manager.StartPolicy()
err = runner.Start()
if err == nil {
t.Error("Expected error when starting policy manager twice")
t.Error("Expected error when starting script twice")
}
}
@@ -1150,8 +1169,8 @@ func TestScriptPolicyDisabledFallsBackToDefault(t *testing.T) {
},
},
Manager: &PolicyManager{
enabled: false, // Policy is disabled
isRunning: false,
enabled: false, // Policy is disabled
runners: make(map[string]*ScriptRunner),
},
}
@@ -1354,8 +1373,8 @@ func TestScriptProcessingDisabledFallsBackToDefault(t *testing.T) {
},
},
Manager: &PolicyManager{
enabled: false, // Policy is disabled
isRunning: false,
enabled: false, // Policy is disabled
runners: make(map[string]*ScriptRunner),
},
}
@@ -1495,6 +1514,213 @@ func TestDefaultPolicyLogicWithRules(t *testing.T) {
}
}
func TestRuleScriptLoading(t *testing.T) {
// This test validates that a policy script loads for a specific Rule
// and properly processes events
// Create temporary directory for test files
tempDir := t.TempDir()
scriptPath := filepath.Join(tempDir, "test-rule-script.sh")
// Create a test script that accepts events with "allowed" in content
scriptContent := `#!/bin/bash
while IFS= read -r line; do
if echo "$line" | grep -q 'allowed'; then
echo '{"action":"accept","msg":"Content approved"}'
else
echo '{"action":"reject","msg":"Content not allowed"}'
fi
done
`
err := os.WriteFile(scriptPath, []byte(scriptContent), 0755)
if err != nil {
t.Fatalf("Failed to create test script: %v", err)
}
// Create policy manager with script support
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
manager := &PolicyManager{
ctx: ctx,
cancel: cancel,
configDir: tempDir,
scriptPath: filepath.Join(tempDir, "default-policy.sh"), // Different from rule script
enabled: true,
runners: make(map[string]*ScriptRunner),
}
// Create policy with a rule that uses the script
policy := &P{
DefaultPolicy: "deny",
Manager: manager,
Rules: map[int]Rule{
4678: {
Description: "Test rule with custom script",
Script: scriptPath, // Rule-specific script path
},
},
}
// Generate test keypairs
eventSigner, eventPubkey := generateTestKeypair(t)
// Pre-start the script before running tests
runner := manager.getOrCreateRunner(scriptPath)
err = runner.Start()
if err != nil {
t.Fatalf("Failed to start script: %v", err)
}
// Wait for script to be ready
time.Sleep(200 * time.Millisecond)
if !runner.IsRunning() {
t.Fatal("Script should be running after Start()")
}
// Test sending a warmup event to ensure script is responsive
signer := p8k.MustNew()
signer.Generate()
warmupEv := event.New()
warmupEv.CreatedAt = time.Now().Unix()
warmupEv.Kind = 4678
warmupEv.Content = []byte("warmup")
warmupEv.Tags = tag.NewS()
warmupEv.Sign(signer)
warmupEvent := &PolicyEvent{
E: warmupEv,
IPAddress: "127.0.0.1",
}
// Send warmup event to verify script is responding
_, err = runner.ProcessEvent(warmupEvent)
if err != nil {
t.Fatalf("Script not responding to warmup event: %v", err)
}
t.Log("Script is ready and responding")
// Test 1: Event with "allowed" content should be accepted
t.Run("script_accepts_allowed_content", func(t *testing.T) {
testEvent := createTestEvent(t, eventSigner, "this is allowed content", 4678)
allowed, err := policy.CheckPolicy("write", testEvent, eventPubkey, "127.0.0.1")
if err != nil {
t.Logf("Policy check failed: %v", err)
// Check if script exists
if _, statErr := os.Stat(scriptPath); statErr != nil {
t.Errorf("Script file error: %v", statErr)
}
t.Fatalf("Unexpected error during policy check: %v", err)
}
if !allowed {
t.Error("Expected event with 'allowed' content to be accepted by script")
t.Logf("Event content: %s", string(testEvent.Content))
}
// Verify the script runner was created and is running
manager.mutex.RLock()
runner, exists := manager.runners[scriptPath]
manager.mutex.RUnlock()
if !exists {
t.Fatal("Expected script runner to be created for rule script path")
}
if !runner.IsRunning() {
t.Error("Expected script runner to be running after processing event")
}
})
// Test 2: Event without "allowed" content should be rejected
t.Run("script_rejects_disallowed_content", func(t *testing.T) {
testEvent := createTestEvent(t, eventSigner, "this is not permitted", 4678)
allowed, err := policy.CheckPolicy("write", testEvent, eventPubkey, "127.0.0.1")
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
if allowed {
t.Error("Expected event without 'allowed' content to be rejected by script")
}
})
// Test 3: Verify script path is correct (rule-specific, not default)
t.Run("script_path_is_rule_specific", func(t *testing.T) {
manager.mutex.RLock()
runner, exists := manager.runners[scriptPath]
_, defaultExists := manager.runners[manager.scriptPath]
manager.mutex.RUnlock()
if !exists {
t.Fatal("Expected rule-specific script runner to exist")
}
if defaultExists {
t.Error("Default script runner should not be created when only rule-specific scripts are used")
}
// Verify the runner is using the correct script path
if runner.scriptPath != scriptPath {
t.Errorf("Expected runner to use script path %s, got %s", scriptPath, runner.scriptPath)
}
})
// Test 4: Multiple events should use the same script instance
t.Run("script_reused_for_multiple_events", func(t *testing.T) {
// Get initial runner
manager.mutex.RLock()
initialRunner, _ := manager.runners[scriptPath]
initialRunnerCount := len(manager.runners)
manager.mutex.RUnlock()
// Process multiple events
for i := 0; i < 5; i++ {
content := "this is allowed message " + string(rune('0'+i))
testEvent := createTestEvent(t, eventSigner, content, 4678)
_, err := policy.CheckPolicy("write", testEvent, eventPubkey, "127.0.0.1")
if err != nil {
t.Errorf("Unexpected error on event %d: %v", i, err)
}
}
// Verify same runner is used
manager.mutex.RLock()
currentRunner, _ := manager.runners[scriptPath]
currentRunnerCount := len(manager.runners)
manager.mutex.RUnlock()
if currentRunner != initialRunner {
t.Error("Expected same runner instance to be reused for multiple events")
}
if currentRunnerCount != initialRunnerCount {
t.Errorf("Expected runner count to stay at %d, got %d", initialRunnerCount, currentRunnerCount)
}
})
// Test 5: Different kind without script should use default policy
t.Run("different_kind_uses_default_policy", func(t *testing.T) {
testEvent := createTestEvent(t, eventSigner, "any content", 1) // Kind 1 has no rule
allowed, err := policy.CheckPolicy("write", testEvent, eventPubkey, "127.0.0.1")
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
// Should be denied by default policy (deny)
if allowed {
t.Error("Expected event of kind without rule to be denied by default policy")
}
})
// Cleanup: Stop the script
manager.mutex.RLock()
runner, exists := manager.runners[scriptPath]
manager.mutex.RUnlock()
if exists && runner.IsRunning() {
runner.Stop()
}
}
func TestPolicyFilterProcessing(t *testing.T) {
// Test policy filter processing using the provided filter JSON specification
filterJSON := []byte(`{

View File

@@ -1 +1 @@
v0.27.0
v0.27.3

154
scripts/BOOTSTRAP.md Normal file
View File

@@ -0,0 +1,154 @@
# ORLY Relay Bootstrap Script
This directory contains a bootstrap script that automates the deployment of the ORLY relay.
## Quick Start
### One-Line Installation
Clone the repository and deploy the relay with a single command:
```bash
curl -sSL https://git.nostrdev.com/mleku/next.orly.dev/raw/branch/main/scripts/bootstrap.sh | bash
```
**Note:** This assumes the script is accessible at the raw URL path. Adjust the URL based on your git server's raw file URL format.
### Alternative: Download and Execute
If you prefer to review the script before running it:
```bash
# Download the script
curl -o bootstrap.sh https://git.nostrdev.com/mleku/next.orly.dev/raw/branch/main/scripts/bootstrap.sh
# Review the script
cat bootstrap.sh
# Make it executable and run
chmod +x bootstrap.sh
./bootstrap.sh
```
## What the Bootstrap Script Does
1. **Checks Prerequisites**
- Verifies that `git` is installed on your system
2. **Clones or Updates Repository**
- Clones the repository to `~/src/next.orly.dev` if it doesn't exist
- If the repository already exists, pulls the latest changes from the main branch
- Stashes any local changes before updating
3. **Runs Deployment**
- Executes `scripts/deploy.sh` to:
- Install Go if needed
- Build the ORLY relay with embedded web UI
- Install the binary to `~/.local/bin/orly`
- Set up systemd service
- Configure necessary capabilities
4. **Provides Next Steps**
- Shows commands to start, check status, and view logs
## Post-Installation
After the bootstrap script completes, you can:
### Start the relay
```bash
sudo systemctl start orly
```
### Enable on boot
```bash
sudo systemctl enable orly
```
### Check status
```bash
sudo systemctl status orly
```
### View logs
```bash
sudo journalctl -u orly -f
```
### View relay identity
```bash
~/.local/bin/orly identity
```
## Configuration
The relay configuration is managed through environment variables. Edit the systemd service file to configure:
```bash
sudo systemctl edit orly
```
See the main README.md for available configuration options.
## Troubleshooting
### Git Not Found
```bash
# Ubuntu/Debian
sudo apt-get update && sudo apt-get install -y git
# Fedora/RHEL
sudo dnf install -y git
# Arch
sudo pacman -S git
```
### Permission Denied Errors
Make sure your user has sudo privileges for systemd service management.
### Port 443 Already in Use
If you're running TLS on port 443, make sure no other service is using that port:
```bash
sudo netstat -tlnp | grep :443
```
### Script Fails to Clone
If the repository URL is not accessible, you may need to:
- Check your network connection
- Verify the git server is accessible
- Use SSH URL instead (modify the script's `REPO_URL` variable)
## Manual Deployment
If you prefer to deploy manually without the bootstrap script:
```bash
# Clone repository
git clone https://git.nostrdev.com/mleku/next.orly.dev.git ~/src/next.orly.dev
# Enter directory
cd ~/src/next.orly.dev
# Run deployment
./scripts/deploy.sh
```
## Security Considerations
When running scripts from the internet:
1. Always review the script contents before execution
2. Use HTTPS URLs to prevent man-in-the-middle attacks
3. Verify the source is trustworthy
4. Consider using the "download and review" method instead of piping directly to bash
## Support
For issues or questions:
- Open an issue on the git repository
- Check the main README.md for detailed documentation
- Review logs with `sudo journalctl -u orly -f`

138
scripts/bootstrap.sh Executable file
View File

@@ -0,0 +1,138 @@
#!/usr/bin/env bash
#
# Bootstrap script for ORLY relay
#
# This script clones the ORLY repository and runs the deployment script.
# It can be executed directly via curl:
#
# curl -sSL https://git.nostrdev.com/mleku/next.orly.dev/raw/branch/main/scripts/bootstrap.sh | bash
#
# Or downloaded and executed:
#
# curl -o bootstrap.sh https://git.nostrdev.com/mleku/next.orly.dev/raw/branch/main/scripts/bootstrap.sh
# chmod +x bootstrap.sh
# ./bootstrap.sh
set -e # Exit on error
set -u # Exit on undefined variable
set -o pipefail # Exit on pipe failure
# Configuration
REPO_URL="https://git.nostrdev.com/mleku/next.orly.dev.git"
REPO_NAME="next.orly.dev"
CLONE_DIR="${HOME}/src/${REPO_NAME}"
# Colors for output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m' # No Color
# Print functions
print_info() {
echo -e "${BLUE}[INFO]${NC} $1"
}
print_success() {
echo -e "${GREEN}[SUCCESS]${NC} $1"
}
print_warning() {
echo -e "${YELLOW}[WARNING]${NC} $1"
}
print_error() {
echo -e "${RED}[ERROR]${NC} $1"
}
# Error handler
error_exit() {
print_error "$1"
exit 1
}
# Check if git is installed
check_git() {
if ! command -v git &> /dev/null; then
error_exit "git is not installed. Please install git and try again."
fi
print_success "git is installed"
}
# Clone or update repository
clone_or_update_repo() {
if [ -d "${CLONE_DIR}/.git" ]; then
print_info "Repository already exists at ${CLONE_DIR}"
print_info "Updating repository..."
cd "${CLONE_DIR}" || error_exit "Failed to change to directory ${CLONE_DIR}"
# Stash any local changes
if ! git diff-index --quiet HEAD --; then
print_warning "Local changes detected. Stashing them..."
git stash || error_exit "Failed to stash changes"
fi
# Pull latest changes
git pull origin main || error_exit "Failed to update repository"
print_success "Repository updated successfully"
else
print_info "Cloning repository from ${REPO_URL}..."
# Create parent directory if it doesn't exist
mkdir -p "$(dirname "${CLONE_DIR}")" || error_exit "Failed to create directory $(dirname "${CLONE_DIR}")"
# Clone the repository
git clone "${REPO_URL}" "${CLONE_DIR}" || error_exit "Failed to clone repository"
print_success "Repository cloned successfully to ${CLONE_DIR}"
cd "${CLONE_DIR}" || error_exit "Failed to change to directory ${CLONE_DIR}"
fi
}
# Run deployment script
run_deployment() {
print_info "Running deployment script..."
if [ ! -f "${CLONE_DIR}/scripts/deploy.sh" ]; then
error_exit "Deployment script not found at ${CLONE_DIR}/scripts/deploy.sh"
fi
chmod +x "${CLONE_DIR}/scripts/deploy.sh" || error_exit "Failed to make deployment script executable"
"${CLONE_DIR}/scripts/deploy.sh" || error_exit "Deployment failed"
print_success "Deployment completed successfully!"
}
# Main execution
main() {
echo ""
print_info "ORLY Relay Bootstrap Script"
print_info "=============================="
echo ""
check_git
clone_or_update_repo
run_deployment
echo ""
print_success "Bootstrap process completed successfully!"
echo ""
print_info "The ORLY relay has been deployed."
print_info "Repository location: ${CLONE_DIR}"
echo ""
print_info "To start the relay service:"
echo " sudo systemctl start orly"
echo ""
print_info "To check the relay status:"
echo " sudo systemctl status orly"
echo ""
print_info "To view relay logs:"
echo " sudo journalctl -u orly -f"
echo ""
}
# Run main function
main