Compare commits
29 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d3dca6c2a5 | |||
| 29f4f8cde6 | |||
| c5acd13df2 | |||
| 41485cbe22 | |||
| c6bf7bb84e | |||
| 30239c6f50 | |||
| d21f6c8be9 | |||
| 0bee82e863 | |||
| bfc2b1f6eb | |||
| 7436b3b148 | |||
| a70ce5c4af | |||
| 415adf2077 | |||
| 3b5d89fdb9 | |||
| 2e73c6dc13 | |||
| 909d84b36e | |||
| 959e5eb959 | |||
| df6d78b6ef | |||
| 6c730c9775 | |||
| a6c471a97a | |||
| ab4bb84ed6 | |||
| 7d14d2b672 | |||
| 4bba1e8c02 | |||
| 3d598040dd | |||
| 09dc449a5c | |||
| 86c1d159cb | |||
| be79c014d4 | |||
| 081973c904 | |||
| c21950493a | |||
| ce39f2a910 |
@@ -72,3 +72,90 @@ git push -u origin <feature-branch-name>
|
|||||||
gh pr create --fill
|
gh pr create --fill
|
||||||
```
|
```
|
||||||
Wait for CI to pass on the PR before merging.
|
Wait for CI to pass on the PR before merging.
|
||||||
|
|
||||||
|
## Batch PR Workflow
|
||||||
|
|
||||||
|
When handling multiple issues split across several PRs that target the same files:
|
||||||
|
|
||||||
|
1. **Group issues by logical category** into separate PR branches (e.g., memory-safety, refactoring, test-coverage).
|
||||||
|
2. **Fix and push** each branch independently. Let CI run on each PR.
|
||||||
|
3. **Run all 3 reviewer types** on each PR and post results to Gitea via `tea pr approve/reject` or the Gitea API:
|
||||||
|
- `reviewer` — general code correctness
|
||||||
|
- `code-quality-guardian` — code quality, duplication, complexity
|
||||||
|
- `security-auditor` — vulnerability assessment
|
||||||
|
4. **Iterate**: if any reviewer requests changes, fix, push, re-review. Repeat until all 3 approve.
|
||||||
|
5. **Merge approved PRs** one at a time into `main`.
|
||||||
|
6. **Create a combined merge branch** for the remaining PRs that conflict with the new `main`:
|
||||||
|
```bash
|
||||||
|
git checkout -b merge-all origin/main
|
||||||
|
for branch in branch1 branch2 branch3; do
|
||||||
|
git merge origin/$branch --no-edit || true
|
||||||
|
# Resolve conflicts, build, test
|
||||||
|
done
|
||||||
|
```
|
||||||
|
7. **Run review again** on the combined branch. Fix issues, push, re-review until approved.
|
||||||
|
8. **Merge** the combined PR, **close** the redundant individual PRs, and **close all resolved issues** via the Gitea API:
|
||||||
|
```bash
|
||||||
|
curl -s -X PATCH -H "Authorization: token $TOKEN" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"state":"closed"}' \
|
||||||
|
"https://gitea.tap-tap.win/api/v1/repos/owner/repo/issues/<number>"
|
||||||
|
```
|
||||||
|
|
||||||
|
## CI Troubleshooting
|
||||||
|
|
||||||
|
### If lint (clang-format) fails
|
||||||
|
Run clang-format in the CI Docker image to match the exact CI version:
|
||||||
|
```bash
|
||||||
|
docker run --rm -v "$PWD:/workspace" -w /workspace gitea.tap-tap.win/taptap/fastsync-ci:v9 \
|
||||||
|
sh -c 'find src/ tests/ -name "*.c" -o -name "*.h" | xargs clang-format -i'
|
||||||
|
```
|
||||||
|
|
||||||
|
### If cppcheck fails
|
||||||
|
Fix reported issues locally, then verify with:
|
||||||
|
```bash
|
||||||
|
docker run --rm -v "$PWD:/workspace" -w /workspace gitea.tap-tap.win/taptap/fastsync-ci:v9 \
|
||||||
|
sh -c 'cppcheck --enable=warning,style,performance,portability --suppress=missingIncludeSystem --error-exitcode=1 --inline-suppr src/ tests/'
|
||||||
|
```
|
||||||
|
|
||||||
|
### If integration tests fail
|
||||||
|
Run locally before pushing:
|
||||||
|
```bash
|
||||||
|
python3 -m pytest tests/ -v --tb=short
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gitea API & tea CLI
|
||||||
|
|
||||||
|
### Check CI status via API
|
||||||
|
```bash
|
||||||
|
TOKEN="<token>"
|
||||||
|
curl -s -H "Authorization: token $TOKEN" \
|
||||||
|
"https://gitea.tap-tap.win/api/v1/repos/TapTap/FastSync/actions/runs?limit=5" \
|
||||||
|
| python3 -c "
|
||||||
|
import json,sys; d=json.load(sys.stdin)
|
||||||
|
for r in d.get('workflow_runs',[]):
|
||||||
|
path = r.get('path','')
|
||||||
|
prn = path.split('@')[1].replace('refs/pull/','').replace('/head','') if '@' in path else ''
|
||||||
|
print(f'PR #{prn}: sha={r[\"head_sha\"][:8]} {r[\"status\"]} {r.get(\"conclusion\",\"\")}')
|
||||||
|
"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Post review comments
|
||||||
|
```bash
|
||||||
|
curl -s -X POST -H "Authorization: token $TOKEN" -H "Content-Type: application/json" \
|
||||||
|
-d '{"body":"MARKDOWN_REVIEW_BODY"}' \
|
||||||
|
"https://gitea.tap-tap.win/api/v1/repos/TapTap/FastSync/issues/<PR_NUMBER>/comments"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use tea for PR operations
|
||||||
|
```bash
|
||||||
|
tea pr list --repo TapTap/FastSync
|
||||||
|
tea pr close <number> --repo TapTap/FastSync
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common pitfalls
|
||||||
|
|
||||||
|
- **`__thread` on shared SSL context**: io_ssl must NOT be thread-local — worker threads inherit the SSL context from the main thread. Use regular `static SSL* io_ssl`.
|
||||||
|
- **SSL WANT_READ/WANT_WRITE retry**: Always retry on `SSL_ERROR_WANT_READ` and `SSL_ERROR_WANT_WRITE` in `send_n_data`/`receive_n_data`. Removing these breaks TLS multithreaded transfers.
|
||||||
|
- **clang-format version**: The CI image uses clang-format 18. Always format inside the CI Docker container for exact match.
|
||||||
|
- **Merge order matters**: Merge the most comprehensive branch first, then smaller ones, to minimize conflicts when creating a combined branch.
|
||||||
|
|||||||
@@ -56,6 +56,8 @@ static void print_usage(void) {
|
|||||||
printf(" --key <path> TLS private key file (PEM)\n");
|
printf(" --key <path> TLS private key file (PEM)\n");
|
||||||
printf(" --ca <path> TLS CA certificate file (PEM)\n");
|
printf(" --ca <path> TLS CA certificate file (PEM)\n");
|
||||||
printf(" --partial Keep partial files on interrupted transfer\n");
|
printf(" --partial Keep partial files on interrupted transfer\n");
|
||||||
|
printf(" --fastsync-server-path <path>\n");
|
||||||
|
printf(" Path to fastsync-server on remote (default: fastsync-server)\n");
|
||||||
printf(" --help Show this help\n");
|
printf(" --help Show this help\n");
|
||||||
printf(" -V, --version Show version and exit\n");
|
printf(" -V, --version Show version and exit\n");
|
||||||
}
|
}
|
||||||
@@ -224,6 +226,9 @@ int main(int argc, char* argv[]) {
|
|||||||
config->tls_ca = str_dup(argv[++i]);
|
config->tls_ca = str_dup(argv[++i]);
|
||||||
} else if (strcmp(argv[i], "--partial") == 0) {
|
} else if (strcmp(argv[i], "--partial") == 0) {
|
||||||
config->partial = true;
|
config->partial = true;
|
||||||
|
} else if (strcmp(argv[i], "--fastsync-server-path") == 0 && i + 1 < argc) {
|
||||||
|
free(config->fastsync_server_path);
|
||||||
|
config->fastsync_server_path = str_dup(argv[++i]);
|
||||||
} else if (strcmp(argv[i], "-v") == 0 || strcmp(argv[i], "--verbose") == 0) {
|
} else if (strcmp(argv[i], "-v") == 0 || strcmp(argv[i], "--verbose") == 0) {
|
||||||
set_log_level(LOG_LEVEL_DEBUG);
|
set_log_level(LOG_LEVEL_DEBUG);
|
||||||
} else if (argv[i][0] == '-') {
|
} else if (argv[i][0] == '-') {
|
||||||
|
|||||||
@@ -228,7 +228,8 @@ static int send_chunks_multithreaded(void* pipeline_context) {
|
|||||||
fprintf(stderr, "Error: -f/--sendfile is not supported with SSH transport\n");
|
fprintf(stderr, "Error: -f/--sendfile is not supported with SSH transport\n");
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
client = client_connect_ssh(context->config->ssh_destination, context->config->ssh_port);
|
client = client_connect_ssh(context->config->ssh_destination, context->config->ssh_port,
|
||||||
|
context->config->fastsync_server_path);
|
||||||
} else if (context->config->use_tls) {
|
} else if (context->config->use_tls) {
|
||||||
client = client_create();
|
client = client_create();
|
||||||
if (!client || !client_connect_tls(client, context->config->server_host,
|
if (!client || !client_connect_tls(client, context->config->server_host,
|
||||||
@@ -385,7 +386,8 @@ int send_files(Config* config) {
|
|||||||
fprintf(stderr, "Error: -f/--sendfile is not supported with SSH transport\n");
|
fprintf(stderr, "Error: -f/--sendfile is not supported with SSH transport\n");
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
client = client_connect_ssh(config->ssh_destination, config->ssh_port);
|
client =
|
||||||
|
client_connect_ssh(config->ssh_destination, config->ssh_port, config->fastsync_server_path);
|
||||||
if (!client)
|
if (!client)
|
||||||
return 1;
|
return 1;
|
||||||
} else if (config->use_tls) {
|
} else if (config->use_tls) {
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ Config* config_create(char* version, char* send_directory, char* receive_directo
|
|||||||
config->ssh_port = 22;
|
config->ssh_port = 22;
|
||||||
config->transport = TRANSPORT_TCP;
|
config->transport = TRANSPORT_TCP;
|
||||||
config->ssh_destination = NULL;
|
config->ssh_destination = NULL;
|
||||||
|
config->fastsync_server_path = NULL;
|
||||||
config->exclude_patterns = NULL;
|
config->exclude_patterns = NULL;
|
||||||
config->exclude_count = 0;
|
config->exclude_count = 0;
|
||||||
config->include_patterns = NULL;
|
config->include_patterns = NULL;
|
||||||
@@ -88,6 +89,7 @@ void config_delete(Config* config) {
|
|||||||
free(config->send_directory);
|
free(config->send_directory);
|
||||||
free(config->receive_root_directory);
|
free(config->receive_root_directory);
|
||||||
free(config->ssh_destination);
|
free(config->ssh_destination);
|
||||||
|
free(config->fastsync_server_path);
|
||||||
for (int i = 0; i < config->exclude_count; i++)
|
for (int i = 0; i < config->exclude_count; i++)
|
||||||
free(config->exclude_patterns[i]);
|
free(config->exclude_patterns[i]);
|
||||||
free(config->exclude_patterns);
|
free(config->exclude_patterns);
|
||||||
@@ -238,6 +240,7 @@ Config* config_receive(int file_descriptor) {
|
|||||||
config->ssh_port = 22;
|
config->ssh_port = 22;
|
||||||
config->transport = TRANSPORT_TCP;
|
config->transport = TRANSPORT_TCP;
|
||||||
config->ssh_destination = NULL;
|
config->ssh_destination = NULL;
|
||||||
|
config->fastsync_server_path = NULL;
|
||||||
config->exclude_patterns = NULL;
|
config->exclude_patterns = NULL;
|
||||||
config->exclude_count = 0;
|
config->exclude_count = 0;
|
||||||
config->include_patterns = NULL;
|
config->include_patterns = NULL;
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ typedef struct Config {
|
|||||||
int ssh_port;
|
int ssh_port;
|
||||||
TransportType transport;
|
TransportType transport;
|
||||||
char* ssh_destination;
|
char* ssh_destination;
|
||||||
|
char* fastsync_server_path;
|
||||||
char** exclude_patterns;
|
char** exclude_patterns;
|
||||||
int exclude_count;
|
int exclude_count;
|
||||||
char** include_patterns;
|
char** include_patterns;
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ static int parse_remote_dest(const char* dest, RemoteDest* r) {
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
Client* client_connect_ssh(const char* destination, int port) {
|
Client* client_connect_ssh(const char* destination, int port, const char* server_path) {
|
||||||
RemoteDest r;
|
RemoteDest r;
|
||||||
if (parse_remote_dest(destination, &r) != 0) {
|
if (parse_remote_dest(destination, &r) != 0) {
|
||||||
fprintf(stderr, "Invalid remote destination: %s\n", destination);
|
fprintf(stderr, "Invalid remote destination: %s\n", destination);
|
||||||
@@ -152,7 +152,7 @@ Client* client_connect_ssh(const char* destination, int port) {
|
|||||||
_exit(1);
|
_exit(1);
|
||||||
}
|
}
|
||||||
ssh_argv[ac++] = ssh_user;
|
ssh_argv[ac++] = ssh_user;
|
||||||
ssh_argv[ac++] = "fastsync-server";
|
ssh_argv[ac++] = (char*)(server_path ? server_path : "fastsync-server");
|
||||||
ssh_argv[ac++] = "--stdio";
|
ssh_argv[ac++] = "--stdio";
|
||||||
ssh_argv[ac] = NULL;
|
ssh_argv[ac] = NULL;
|
||||||
execvp("ssh", ssh_argv);
|
execvp("ssh", ssh_argv);
|
||||||
@@ -174,7 +174,8 @@ Client* client_connect_ssh(const char* destination, int port) {
|
|||||||
close(sv[0]);
|
close(sv[0]);
|
||||||
waitpid(pid, NULL, 0);
|
waitpid(pid, NULL, 0);
|
||||||
remote_dest_destroy(&r);
|
remote_dest_destroy(&r);
|
||||||
fprintf(stderr, "Error: could not launch 'fastsync-server --stdio' on remote\n");
|
fprintf(stderr, "Error: could not launch '%s --stdio' on remote\n",
|
||||||
|
server_path ? server_path : "fastsync-server");
|
||||||
return NULL;
|
return NULL;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
#include "transport_tcp.h"
|
#include "transport_tcp.h"
|
||||||
|
|
||||||
Client* client_connect_ssh(const char* destination, int port);
|
Client* client_connect_ssh(const char* destination, int port, const char* server_path);
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -9,14 +9,14 @@
|
|||||||
static void test_ssh_connect_invalid_dest() {
|
static void test_ssh_connect_invalid_dest() {
|
||||||
/* Missing colon — parse_remote_dest should fail and return NULL */
|
/* Missing colon — parse_remote_dest should fail and return NULL */
|
||||||
/* cppcheck-suppress constVariablePointer */
|
/* cppcheck-suppress constVariablePointer */
|
||||||
Client* client = client_connect_ssh("invalid-destination-no-colon", 22);
|
Client* client = client_connect_ssh("invalid-destination-no-colon", 22, NULL);
|
||||||
EXPECT_NULL(client);
|
EXPECT_NULL(client);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Test client_connect_ssh with empty destination */
|
/* Test client_connect_ssh with empty destination */
|
||||||
static void test_ssh_connect_empty_dest() {
|
static void test_ssh_connect_empty_dest() {
|
||||||
/* cppcheck-suppress constVariablePointer */
|
/* cppcheck-suppress constVariablePointer */
|
||||||
Client* client = client_connect_ssh("", 22);
|
Client* client = client_connect_ssh("", 22, NULL);
|
||||||
EXPECT_NULL(client);
|
EXPECT_NULL(client);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ static void test_ssh_connect_empty_dest() {
|
|||||||
* parse_remote_dest succeeds, ssh is exec'd and fails, but the function
|
* parse_remote_dest succeeds, ssh is exec'd and fails, but the function
|
||||||
* creates a Client that must be cleaned up. */
|
* creates a Client that must be cleaned up. */
|
||||||
static void test_ssh_connect_malformed() {
|
static void test_ssh_connect_malformed() {
|
||||||
Client* client = client_connect_ssh(":", 22);
|
Client* client = client_connect_ssh(":", 22, NULL);
|
||||||
/* ssh binary exists, so exec succeeds; the function returns a Client.
|
/* ssh binary exists, so exec succeeds; the function returns a Client.
|
||||||
* We just verify it doesn't crash and clean up properly. */
|
* We just verify it doesn't crash and clean up properly. */
|
||||||
if (client != NULL) {
|
if (client != NULL) {
|
||||||
@@ -37,7 +37,7 @@ static void test_ssh_connect_malformed() {
|
|||||||
/* Test client_connect_ssh with valid format but unreachable host.
|
/* Test client_connect_ssh with valid format but unreachable host.
|
||||||
* The function launches ssh which will fail to connect, returns a Client. */
|
* The function launches ssh which will fail to connect, returns a Client. */
|
||||||
static void test_ssh_connect_unreachable() {
|
static void test_ssh_connect_unreachable() {
|
||||||
Client* client = client_connect_ssh("nonexistent.invalid:/remote/path", 22);
|
Client* client = client_connect_ssh("nonexistent.invalid:/remote/path", 22, NULL);
|
||||||
if (client != NULL) {
|
if (client != NULL) {
|
||||||
client_disconnect(client);
|
client_disconnect(client);
|
||||||
client_delete(client);
|
client_delete(client);
|
||||||
|
|||||||
Reference in New Issue
Block a user