Skip to content

Commit 9b8df7e

Browse files
committed
fix: README
1 parent 84b352e commit 9b8df7e

File tree

1 file changed

+0
-82
lines changed

1 file changed

+0
-82
lines changed

README.md

Lines changed: 0 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -91,85 +91,3 @@ go run examples/sip_client.go -server 127.0.0.1:5060 -user alice
9191
- INVITE: Call initiation
9292
- BYE: Call termination
9393
- ACK: Acknowledgment handling
94-
95-
## Testing
96-
97-
Run the test suite with:
98-
99-
```
100-
go test ./...
101-
```
102-
103-
This will run all tests in all packages. The test suite includes:
104-
105-
- Unit tests for SIP message parsing and generation
106-
- Mock-based tests for the SIP server
107-
- Configuration file handling tests
108-
- Command-line argument parsing tests
109-
110-
For more verbose output, add the `-v` flag:
111-
112-
```
113-
go test -v ./...
114-
```
115-
116-
For race condition detection:
117-
118-
```
119-
go test -race ./...
120-
```
121-
122-
### Testing Requirements
123-
124-
Tests require a `testdata` directory with test configuration files. This is automatically created when running tests via GitHub Actions, but for local testing you might need to create it:
125-
126-
```bash
127-
mkdir -p testdata config/testdata
128-
echo '{"server":{"port":"5070","log_level":"info","bind_addr":"127.0.0.1"}}' > testdata/test_config.json
129-
echo '{"server":{"port":"5070","log_level":"info","bind_addr":"127.0.0.1"}}' > config/testdata/test_config.json
130-
```
131-
132-
## Continuous Integration
133-
134-
This project uses GitHub Actions for continuous integration:
135-
136-
- Builds and tests the code on multiple Go versions (1.18, 1.19, 1.20)
137-
- Runs linting with golangci-lint
138-
- Generates test coverage reports and uploads to Codecov
139-
- Performs detailed package-by-package testing on failures
140-
141-
You can see the current build status and test coverage at the top of this README.
142-
143-
## Troubleshooting
144-
145-
### Running Tests
146-
147-
If you encounter issues with running tests:
148-
149-
1. Make sure the required test directories exist:
150-
151-
```bash
152-
mkdir -p testdata config/testdata
153-
```
154-
155-
2. Create test configuration files:
156-
157-
```bash
158-
echo '{"server":{"port":"5070","log_level":"info","bind_addr":"127.0.0.1"}}' > testdata/test_config.json
159-
echo '{"server":{"port":"5070","log_level":"info","bind_addr":"127.0.0.1"}}' > config/testdata/test_config.json
160-
```
161-
162-
3. Run tests with verbose output:
163-
164-
```bash
165-
go test -v ./...
166-
```
167-
168-
4. For more detailed debugging, run tests one package at a time:
169-
```bash
170-
go test -v github.com/user/go-sip/sip
171-
```
172-
173-
## Disclaimer
174-
175-
This is a simple SIP server for demonstration purposes and is not recommended for production use. A real SIP server requires additional features such as authentication, security, and full SIP specification support.

0 commit comments

Comments
 (0)