# Structure Tool SIGTERM Testing Documentation

## Overview
This document outlines the changes made to test SIGTERM handling in the structure tool using local unstract-sdk modifications. The goal was to integrate local SDK changes that include SIGTERM signal handling and verify the tool responds gracefully to termination signals.

## Directory Structure & Workflow

### Build vs Run Locations
- **Build Location**: `/home/kirtimanmishra/Zipstack/Repositories/` (repositories root)
- **Run Location**: `/home/kirtimanmishra/Zipstack/Repositories/unstract/tools/structure/` (structure tool directory)

### Why Build from Repositories Root?
Building from the repositories root allows access to both:
- `unstract-sdk/` directory (contains local SDK changes)
- `unstract/tools/structure/` directory (contains the structure tool)

This enables copying the local SDK into the Docker build context.

## Changes Made

### 1. Dockerfile Changes
**File**: `unstract/tools/structure/Dockerfile`

Added before the requirements installation:
# Copy the unstract-sdk directory first
COPY unstract-sdk ${APP_HOME}/unstract-sdk/

**Purpose**: Copies the local unstract-sdk (with SIGTERM changes) into the Docker image build context.

### 2. Requirements.txt Changes
**File**: `unstract/tools/structure/requirements.txt`

**Before**:
unstract-sdk[aws]~=0.74.0

**After**:
# unstract-sdk[aws]~=0.74.0
-e ./unstract-sdk
s3fs

**Purpose**: 
- Commented out the PyPI version
- Added local editable install of unstract-sdk
- Added s3fs dependency

### 3. Main.py Changes
**File**: `unstract/tools/structure/src/main.py`

**Added import**:
import time

**Added in run method** (after initial setup):
# Add delay for SIGTERM testing
self.stream_log("Starting 30-second delay for SIGTERM testing...")
time.sleep(30)
self.stream_log("Delay completed, continuing with tool execution...")

**Purpose**: Provides a 30-second window during tool execution to test SIGTERM signal handling.

## Build Instructions

### Prerequisites
1. Local unstract-sdk with SIGTERM changes
2. Structure tool source code
3. Docker installed

### Step 1: Copy SDK to Build Context
# From repositories root
cd /home/kirtimanmishra/Zipstack/Repositories/
cp -r unstract-sdk unstract/tools/structure/

### Step 2: Build Docker Image
# From repositories root
cd /home/kirtimanmishra/Zipstack/Repositories/
docker build -f unstract/tools/structure/Dockerfile -t structure-tool-test .

**Alternative** (from structure tool directory):
# From structure tool directory (after copying SDK)
cd /home/kirtimanmishra/Zipstack/Repositories/unstract/tools/structure/
docker build -t structure-tool-test .

## Run Instructions

### Navigate to Structure Tool Directory
cd /home/kirtimanmishra/Zipstack/Repositories/unstract/tools/structure/

### Run Container (Detached for SIGTERM Testing)
docker run -d --name sigterm-test \
  --network unstract-network \
  --env-file .env \
  -v "$(pwd)/data_dir:/app/data_dir" \
  structure-tool-test:latest \
  --command RUN \
  --settings '{"prompt_registry_id": "479a3cbc-6872-4945-b839-366f6a04751d", "enable_single_pass_extraction": true, "summarize_as_source": true}' \
  --log-level DEBUG

## SIGTERM Testing Methods

### Method 1: docker stop 
# Get container ID
docker ps

# Send SIGTERM with 10-second grace period
docker stop <container-id>

**What happens**:
1. Docker sends SIGTERM to container
2. Waits 10 seconds for graceful shutdown
3. Sends SIGKILL if container hasn't stopped

### Method 2: Ctrl+C (Interactive Mode)
# Run in interactive mode
docker run --rm -it ... structure-tool-test ...

# Press Ctrl+C during the 30-second delay
# This sends SIGINT, which should also be handled

### Method 3: Direct SIGTERM Signal
# Send SIGTERM directly
docker kill --signal=SIGTERM <container-id>

# Or by name
docker kill --signal=SIGTERM sigterm-test