magneto-serge 0.7.0

Multi-language HTTP/WebSocket testing library with record/replay capabilities - like VCR for the modern web
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

# Docker Compose Examples for magneto-serge
#
# Usage:
#   docker-compose -f docker-compose.example.yml up example-explicit-proxy
#   docker-compose -f docker-compose.example.yml up example-transparent-proxy
#   docker-compose -f docker-compose.example.yml up example-integration-test

version: '3.8'

# ========================================
# Example 1: Explicit Proxy (Simple)
# ========================================
# Your app explicitly uses HTTP_PROXY environment variables
#
services:
  example-explicit-proxy:
    image: ghcr.io/taciclei/magneto-serge:latest
    command: replay api-cassette --port 8888
    ports:
      - "8888:8888"
    volumes:
      - ./cassettes:/cassettes
    networks:
      - test-network
    profiles:
      - example-explicit-proxy

  app-with-explicit-proxy:
    image: curlimages/curl:latest
    depends_on:
      - example-explicit-proxy
    environment:
      HTTP_PROXY: http://example-explicit-proxy:8888
      HTTPS_PROXY: http://example-explicit-proxy:8888
      NO_PROXY: localhost,127.0.0.1
    networks:
      - test-network
    command: ["curl", "-v", "http://httpbin.org/get"]
    profiles:
      - example-explicit-proxy

# ========================================
# Example 2: Transparent Proxy (Advanced)
# ========================================
# Uses iptables to intercept all traffic without app modification
#
  example-transparent-proxy:
    build:
      context: .
      dockerfile: Dockerfile.transparent
    cap_add:
      - NET_ADMIN
    volumes:
      - ./cassettes:/cassettes
    environment:
      MAGNETO_MODE: replay
      CASSETTE_NAME: transparent-test
      MAGNETO_PORT: 8888
      TRANSPARENT_PROXY: "true"
    networks:
      - test-network
    profiles:
      - example-transparent-proxy

# ========================================
# Example 3: Integration Test Suite
# ========================================
# Full integration test with backend + frontend + tests
#
  magneto-integration:
    image: ghcr.io/taciclei/magneto-serge:latest
    command: auto integration-cassette --port 8888
    volumes:
      - ./cassettes:/cassettes
    networks:
      - test-network
    healthcheck:
      test: ["CMD", "netstat", "-an", "|", "grep", "8888"]
      interval: 10s
      timeout: 5s
      retries: 3
    profiles:
      - example-integration-test

  backend-api:
    image: node:18-alpine
    depends_on:
      magneto-integration:
        condition: service_healthy
    working_dir: /app
    volumes:
      - ./examples/backend:/app
    environment:
      HTTP_PROXY: http://magneto-integration:8888
      HTTPS_PROXY: http://magneto-integration:8888
      PORT: 3000
    command: ["npm", "start"]
    networks:
      - test-network
    profiles:
      - example-integration-test

  frontend-app:
    image: node:18-alpine
    depends_on:
      - backend-api
    working_dir: /app
    volumes:
      - ./examples/frontend:/app
    environment:
      API_URL: http://backend-api:3000
    command: ["npm", "start"]
    networks:
      - test-network
    profiles:
      - example-integration-test

  test-runner:
    image: curlimages/curl:latest
    depends_on:
      - frontend-app
    networks:
      - test-network
    command: ["curl", "-v", "http://frontend-app:3000/health"]
    profiles:
      - example-integration-test

# ========================================
# Example 4: Record Mode
# ========================================
# Record new cassette from real network traffic
#
  example-record:
    image: ghcr.io/taciclei/magneto-serge:latest
    command: record new-cassette --port 8888
    ports:
      - "8888:8888"
    volumes:
      - ./cassettes:/cassettes
    networks:
      - test-network
    profiles:
      - example-record

  app-recording:
    image: curlimages/curl:latest
    depends_on:
      - example-record
    environment:
      HTTP_PROXY: http://example-record:8888
      HTTPS_PROXY: http://example-record:8888
    networks:
      - test-network
    command: |
      sh -c "
        echo 'Recording network interactions...'
        curl -v http://httpbin.org/get
        curl -v https://api.github.com/users/github
        echo 'Recording complete. Check ./cassettes/new-cassette.json'
      "
    profiles:
      - example-record

# ========================================
# Example 5: Auto Mode (Development)
# ========================================
# Automatically record if cassette missing, else replay
#
  example-auto:
    image: ghcr.io/taciclei/magneto-serge:latest
    command: auto dev-cassette --port 8888
    ports:
      - "8888:8888"
    volumes:
      - ./cassettes:/cassettes
    networks:
      - test-network
    profiles:
      - example-auto

  app-auto-mode:
    image: curlimages/curl:latest
    depends_on:
      - example-auto
    environment:
      HTTP_PROXY: http://example-auto:8888
      HTTPS_PROXY: http://example-auto:8888
    networks:
      - test-network
    command: ["curl", "-v", "http://httpbin.org/get"]
    profiles:
      - example-auto

# ========================================
# Networks
# ========================================
networks:
  test-network:
    driver: bridge
    # Optional: make network internal (no external access)
    # internal: true