mirror of
https://github.com/mjl-/mox.git
synced 2024-12-26 16:33:47 +03:00
28fae96a9b
getting mox to compile required changing code in only a few places where package "syscall" was used: for accessing file access times and for umask handling. an open problem is how to start a process as an unprivileged user on windows. that's why "mox serve" isn't implemented yet. and just finding a way to implement it now may not be good enough in the near future: we may want to starting using a more complete privilege separation approach, with a process handling sensitive tasks (handling private keys, authentication), where we may want to pass file descriptors between processes. how would that work on windows? anyway, getting mox to compile for windows doesn't mean it works properly on windows. the largest issue: mox would normally open a file, rename or remove it, and finally close it. this happens during message delivery. that doesn't work on windows, the rename/remove would fail because the file is still open. so this commit swaps many "remove" and "close" calls. renames are a longer story: message delivery had two ways to deliver: with "consuming" the (temporary) message file (which would rename it to its final destination), and without consuming (by hardlinking the file, falling back to copying). the last delivery to a recipient of a message (and the only one in the common case of a single recipient) would consume the message, and the earlier recipients would not. during delivery, the already open message file was used, to parse the message. we still want to use that open message file, and the caller now stays responsible for closing it, but we no longer try to rename (consume) the file. we always hardlink (or copy) during delivery (this works on windows), and the caller is responsible for closing and removing (in that order) the original temporary file. this does cost one syscall more. but it makes the delivery code (responsibilities) a bit simpler. there is one more obvious issue: the file system path separator. mox already used the "filepath" package to join paths in many places, but not everywhere. and it still used strings with slashes for local file access. with this commit, the code now uses filepath.FromSlash for path strings with slashes, uses "filepath" in a few more places where it previously didn't. also switches from "filepath" to regular "path" package when handling mailbox names in a few places, because those always use forward slashes, regardless of local file system conventions. windows can handle forward slashes when opening files, so test code that passes path strings with forward slashes straight to go stdlib file i/o functions are left unchanged to reduce code churn. the regular non-test code, or test code that uses path strings in places other than standard i/o functions, does have the paths converted for consistent paths (otherwise we would end up with paths with mixed forward/backward slashes in log messages). windows cannot dup a listening socket. for "mox localserve", it isn't important, and we can work around the issue. the current approach for "mox serve" (forking a process and passing file descriptors of listening sockets on "privileged" ports) won't work on windows. perhaps it isn't needed on windows, and any user can listen on "privileged" ports? that would be welcome. on windows, os.Open cannot open a directory, so we cannot call Sync on it after message delivery. a cursory internet search indicates that directories cannot be synced on windows. the story is probably much more nuanced than that, with long deep technical details/discussions/disagreement/confusion, like on unix. for "mox localserve" we can get away with making syncdir a no-op.
125 lines
4.4 KiB
Makefile
125 lines
4.4 KiB
Makefile
default: build
|
|
|
|
build:
|
|
# build early to catch syntax errors
|
|
CGO_ENABLED=0 go build
|
|
CGO_ENABLED=0 go vet ./...
|
|
CGO_ENABLED=0 go vet -tags integration
|
|
./gendoc.sh
|
|
(cd webadmin && CGO_ENABLED=0 go run ../vendor/github.com/mjl-/sherpadoc/cmd/sherpadoc/*.go -adjust-function-names none Admin) >webadmin/adminapi.json
|
|
(cd webaccount && CGO_ENABLED=0 go run ../vendor/github.com/mjl-/sherpadoc/cmd/sherpadoc/*.go -adjust-function-names none Account) >webaccount/accountapi.json
|
|
(cd webmail && CGO_ENABLED=0 go run ../vendor/github.com/mjl-/sherpadoc/cmd/sherpadoc/*.go -adjust-function-names none Webmail) >webmail/api.json
|
|
go run vendor/github.com/mjl-/sherpats/cmd/sherpats/main.go -bytes-to-string -slices-nullable -maps-nullable -nullable-optional -namespace api api <webmail/api.json >webmail/api.ts
|
|
# build again, api json files above are embedded
|
|
CGO_ENABLED=0 go build
|
|
|
|
test:
|
|
CGO_ENABLED=0 go test -shuffle=on -coverprofile cover.out ./...
|
|
go tool cover -html=cover.out -o cover.html
|
|
|
|
test-race:
|
|
CGO_ENABLED=1 go test -race -shuffle=on -covermode atomic -coverprofile cover.out ./...
|
|
go tool cover -html=cover.out -o cover.html
|
|
|
|
# note: if testdata/upgradetest.mbox.gz exists, its messages will be imported
|
|
# during tests. helpful for performance/resource consumption tests.
|
|
test-upgrade:
|
|
nice ./test-upgrade.sh
|
|
|
|
check:
|
|
staticcheck ./...
|
|
staticcheck -tags integration
|
|
GOARCH=386 CGO_ENABLED=0 go vet ./...
|
|
|
|
# having "err" shadowed is common, best to not have others
|
|
check-shadow:
|
|
go vet -vettool=$$(which shadow) ./... 2>&1 | grep -v '"err"'
|
|
|
|
fuzz:
|
|
go test -fuzz FuzzParseSignature -fuzztime 5m ./dkim
|
|
go test -fuzz FuzzParseRecord -fuzztime 5m ./dkim
|
|
go test -fuzz . -fuzztime 5m ./dmarc
|
|
go test -fuzz . -fuzztime 5m ./dmarcrpt
|
|
go test -fuzz . -parallel 1 -fuzztime 5m ./imapserver
|
|
go test -fuzz . -parallel 1 -fuzztime 5m ./junk
|
|
go test -fuzz FuzzParseRecord -fuzztime 5m ./mtasts
|
|
go test -fuzz FuzzParsePolicy -fuzztime 5m ./mtasts
|
|
go test -fuzz . -parallel 1 -fuzztime 5m ./smtpserver
|
|
go test -fuzz . -fuzztime 5m ./spf
|
|
go test -fuzz FuzzParseRecord -fuzztime 5m ./tlsrpt
|
|
go test -fuzz FuzzParseMessage -fuzztime 5m ./tlsrpt
|
|
|
|
|
|
test-integration:
|
|
docker image build --pull --no-cache -f Dockerfile -t mox_integration_moxmail .
|
|
docker image build --pull --no-cache -f testdata/integration/Dockerfile.test -t mox_integration_test testdata/integration
|
|
-rm -rf testdata/integration/moxacmepebble/data
|
|
-rm -rf testdata/integration/moxmail2/data
|
|
-rm -f testdata/integration/tmp-pebble-ca.pem
|
|
MOX_UID=$$(id -u) docker-compose -f docker-compose-integration.yml run test
|
|
docker-compose -f docker-compose-integration.yml down --timeout 1
|
|
|
|
|
|
imaptest-build:
|
|
-docker-compose -f docker-compose-imaptest.yml build --no-cache --pull mox
|
|
|
|
imaptest-run:
|
|
-rm -r testdata/imaptest/data
|
|
mkdir testdata/imaptest/data
|
|
docker-compose -f docker-compose-imaptest.yml run --entrypoint /usr/local/bin/imaptest imaptest host=mox port=1143 user=mjl@mox.example pass=testtest mbox=imaptest.mbox
|
|
docker-compose -f docker-compose-imaptest.yml down
|
|
|
|
|
|
fmt:
|
|
go fmt ./...
|
|
gofmt -w -s *.go */*.go
|
|
|
|
jswatch:
|
|
bash -c 'while true; do inotifywait -q -e close_write webadmin/*.html webaccount/*.html webmail/*.ts; make frontend; done'
|
|
|
|
jsinstall:
|
|
-mkdir -p node_modules/.bin
|
|
npm ci
|
|
|
|
jsinstall0:
|
|
-mkdir -p node_modules/.bin
|
|
npm install --save-dev --save-exact jshint@2.13.6 typescript@5.1.6
|
|
|
|
webmail/webmail.js: webmail/api.ts webmail/lib.ts webmail/webmail.ts
|
|
./tsc.sh $@ $^
|
|
|
|
webmail/msg.js: webmail/api.ts webmail/lib.ts webmail/msg.ts
|
|
./tsc.sh $@ $^
|
|
|
|
webmail/text.js: webmail/api.ts webmail/lib.ts webmail/text.ts
|
|
./tsc.sh $@ $^
|
|
|
|
webadmin/admin.htmlx:
|
|
./node_modules/.bin/jshint --extract always webadmin/admin.html | ./fixjshintlines.sh
|
|
|
|
webaccount/account.htmlx:
|
|
./node_modules/.bin/jshint --extract always webaccount/account.html | ./fixjshintlines.sh
|
|
|
|
frontend: webadmin/admin.htmlx webaccount/account.htmlx webmail/webmail.js webmail/msg.js webmail/text.js
|
|
|
|
docker:
|
|
docker build -t mox:dev .
|
|
|
|
docker-release:
|
|
./docker-release.sh
|
|
|
|
buildall:
|
|
GOOS=linux GOARCH=arm go build
|
|
GOOS=linux GOARCH=arm64 go build
|
|
GOOS=linux GOARCH=amd64 go build
|
|
GOOS=linux GOARCH=386 go build
|
|
GOOS=openbsd GOARCH=amd64 go build
|
|
GOOS=freebsd GOARCH=amd64 go build
|
|
GOOS=netbsd GOARCH=amd64 go build
|
|
GOOS=darwin GOARCH=amd64 go build
|
|
GOOS=dragonfly GOARCH=amd64 go build
|
|
GOOS=illumos GOARCH=amd64 go build
|
|
GOOS=solaris GOARCH=amd64 go build
|
|
GOOS=aix GOARCH=ppc64 go build
|
|
GOOS=windows GOARCH=amd64 go build
|
|
# no plan9 for now
|