[Documentation]: <Running dgraph tests on Mac OS>

[glossd]

What version of Dgraph is the target?

Current main branch

Documentation.

The contribution page.

Additional information.

I was trying to run tests on my MacBook.
I ran make docker-image creating the dgraph/dgraph:local image.
Then I ran make test. docker-compose command ended with exit 1 status. I noticed the docker image lacked the /gobin/dgraph file, so I added it in the contrib/Dockerfile, but it didn't help.
Here's the output of the make test

testutil: "" localhost:9080 localhost:5080
Proc ID is 245
Detected architecture: amd64compiling plugin: src="./custom_plugins/anagram/main.go" so="./custom_plugins/0.so"
compiling plugin: src="./custom_plugins/cidr/main.go" so="./custom_plugins/1.so"
compiling plugin: src="./custom_plugins/factor/main.go" so="./custom_plugins/2.so"
compiling plugin: src="./custom_plugins/rune/main.go" so="./custom_plugins/3.so"
plugin build completed. Files are: /Users/i/IdeaProjects/open/dgraph/t/custom_plugins/0.so,/Users/i/IdeaProjects/open/dgraph/t/custom_plugins/1.so,/Users/i/IdeaProjects/open/dgraph/t/custom_plugins/2.so,/Users/i/IdeaProjects/open/dgraph/t/custom_plugins/3.so
Skipping package github.com/dgraph-io/dgraph/systest/1million as its not valid for the selected suite [unit] 
Skipping package github.com/dgraph-io/dgraph/systest/21million/bulk as its not valid for the selected suite [unit] 
Skipping package github.com/dgraph-io/dgraph/systest/21million/live as its not valid for the selected suite [unit] 
Skipping package github.com/dgraph-io/dgraph/systest/bgindex as its not valid for the selected suite [unit] 
Skipping package github.com/dgraph-io/dgraph/systest/bulk_live/bulk as its not valid for the selected suite [unit] 
Skipping package github.com/dgraph-io/dgraph/systest/bulk_live/live as its not valid for the selected suite [unit] 
Skipping package github.com/dgraph-io/dgraph/systest/ldbc as its not valid for the selected suite [unit] 
Found valid task: github.com/dgraph-io/dgraph/ee/acl isCommon:true
Found valid task: github.com/dgraph-io/dgraph/systest isCommon:true
Found valid task: github.com/dgraph-io/dgraph/systest/21million/common isCommon:true
Found valid task: github.com/dgraph-io/dgraph/systest/acl/restore isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/audit isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/audit_encrypted isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/advanced-scenarios/127-Namespace isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/advanced-scenarios/acl-nonAcl isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/advanced-scenarios/deleted-namespace isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/common isCommon:true
Found valid task: github.com/dgraph-io/dgraph/systest/backup/encryption isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/filesystem isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/minio isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/minio-large isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/multi-tenancy isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/backup/nfs-backup isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/bulk_live/common isCommon:true
Found valid task: github.com/dgraph-io/dgraph/systest/cdc isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/cloud isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/export isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/group-delete isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/license isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/loader isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/multi-tenancy isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/mutations-and-queries isCommon:true
Found valid task: github.com/dgraph-io/dgraph/systest/online-restore isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/plugin isCommon:false
Found valid task: github.com/dgraph-io/dgraph/systest/posting-list-benchmark isCommon:true
Found valid task: github.com/dgraph-io/dgraph/worker isCommon:false
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/migrate isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/version isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/zero isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraphtest isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dql isCommon:true
Found valid task: github.com/dgraph-io/dgraph/edgraph isCommon:true
Found valid task: github.com/dgraph-io/dgraph/ee isCommon:true
Found valid task: github.com/dgraph-io/dgraph/algo isCommon:true
Found valid task: github.com/dgraph-io/dgraph/ee/audit isCommon:true
Found valid task: github.com/dgraph-io/dgraph/ee/backup isCommon:true
Found valid task: github.com/dgraph-io/dgraph/ee/enc isCommon:true
Found valid task: github.com/dgraph-io/dgraph/filestore isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/admin isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/api isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/authorization isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/bench isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/dgraph isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/admin_auth/poorman_auth isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/admin_auth/poorman_auth_with_acl isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/auth isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/auth/debug_off isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/auth_closed_by_default isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/common isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/custom_logic isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/directives isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/multi_tenancy isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/normal isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/schema isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/e2e/subscription isCommon:false
Found valid task: github.com/dgraph-io/dgraph/graphql/resolve isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/schema isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/subscription isCommon:true
Found valid task: github.com/dgraph-io/dgraph/graphql/test isCommon:true
Found valid task: github.com/dgraph-io/dgraph/lex isCommon:true
Found valid task: github.com/dgraph-io/dgraph/posting isCommon:true
Found valid task: github.com/dgraph-io/dgraph/protos isCommon:true
Found valid task: github.com/dgraph-io/dgraph/protos/pb isCommon:true
Found valid task: github.com/dgraph-io/dgraph/query isCommon:true
Found valid task: github.com/dgraph-io/dgraph/raftwal isCommon:true
Found valid task: github.com/dgraph-io/dgraph/schema isCommon:true
Found valid task: github.com/dgraph-io/dgraph/chunker isCommon:true
Found valid task: github.com/dgraph-io/dgraph/codec isCommon:true
Found valid task: github.com/dgraph-io/dgraph/codec/benchmark isCommon:true
Found valid task: github.com/dgraph-io/dgraph/compose isCommon:true
Found valid task: github.com/dgraph-io/dgraph/conn isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/embargo isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/integration/acctupsert isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/integration/bank isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/integration/bigdata isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/integration/mutates isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/integration/swap isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/integration/testtxn isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/jepsen isCommon:true
Found valid task: github.com/dgraph-io/dgraph/contrib/jepsen/browser isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph isCommon:false
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/alpha isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/alpha/mutations_mode isCommon:false
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/bulk isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/cert isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/conv isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/debug isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/debuginfo isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/decrypt isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/increment isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/live isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/live/load-json isCommon:true
Found valid task: github.com/dgraph-io/dgraph/t isCommon:true
Found valid task: github.com/dgraph-io/dgraph/task isCommon:true
Found valid task: github.com/dgraph-io/dgraph/telemetry isCommon:true
Found valid task: github.com/dgraph-io/dgraph/testutil isCommon:true
Found valid task: github.com/dgraph-io/dgraph/testutil/custom_plugins/anagram isCommon:true
Found valid task: github.com/dgraph-io/dgraph/testutil/custom_plugins/cidr isCommon:true
Found valid task: github.com/dgraph-io/dgraph/testutil/custom_plugins/factor isCommon:true
Found valid task: github.com/dgraph-io/dgraph/testutil/custom_plugins/rune isCommon:true
Found valid task: github.com/dgraph-io/dgraph/testutil/testaudit isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/acl isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/certrequest isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/certrequireandverify isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/certverifyifgiven isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/mtls_internal/ha_6_node isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/mtls_internal/multi_group isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/mtls_internal/single_node isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/zero_https/all_routes_tls isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tlstest/zero_https/no_tls isCommon:false
Found valid task: github.com/dgraph-io/dgraph/tok isCommon:true
Found valid task: github.com/dgraph-io/dgraph/types isCommon:true
Found valid task: github.com/dgraph-io/dgraph/types/facets isCommon:true
Found valid task: github.com/dgraph-io/dgraph/upgrade isCommon:true
Found valid task: github.com/dgraph-io/dgraph/dgraph/cmd/live/load-uids isCommon:true
Found valid task: github.com/dgraph-io/dgraph/x isCommon:true
Found valid task: github.com/dgraph-io/dgraph/xidmap isCommon:true
Running tests for 122 packages.
Sent 1/122 packages for processing.
Bringing up cluster test-245-1 for package: ../dgraph/docker-compose.yml ...
While running command: "docker-compose --compatibility -f ../dgraph/docker-compose.yml -p test-245-1 up --force-recreate --build --remove-orphans --detach" Error: exit status 1
Running: /Users/i/.go/go1.19.13/bin/go test -failfast -v -tags=integration -timeout 30m github.com/dgraph-io/dgraph/ee/acl with test-245-1
Docker logs for d76db7858f63ce64b47be8b80dcb7ff2f58da90ea9fa5ee45db54bb5185ba325 is  with error <nil> Docker logs for fac9c3cb472939c8b93b31c186eeb878f1cfcd54252f07ed8f4efa7af594f33e is  with error <nil> Docker logs for 1e5b860412ef23bd1d4f10d48d71365675b71578b488f50c3d9cf9c8037c5f68 is  with error <nil> Docker logs for 677c5dd9b3851ebefaf6717006ccb152ea7002ba1a63e6904128d709c4d55af1 is  with error <nil> Docker logs for 1ad0244ad0ea03bfec557586ad94195eb2e12dd0aac81d821942c1379b2b1916 is  with error <nil> Docker logs for 304b477ec2efed06689ce8a4702d23518c995a3d9a5ab6f1003ad0f553e1ff39 is  with error <nil> Docker logs for f23a8feb2e4fe2aa8e89192689af1728b35410a08153281ec3f7fdde0f944423 is  with error <nil> Docker logs for 12bac030955f2cb1a4bb51710e5d4ccaab3a6df8d090b371c6ee3852217a266d is  with error <nil> Docker logs for bb739eca5401fa63dd7b9974662ba7bc5384cadffb1ee7f7d4dc47dcfd037406 is  with error <nil> ---> LOGS for test-245-1 written to ./test-245-1316132693.log .
CLUSTER STOPPED: test-245-1
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
WARN[0000] The "COVERAGE_OUTPUT" variable is not set. Defaulting to a blank string. 
[+] Running 11/11
 ✔ Container test-245-1_minio_1   Removed                                                                                                                                                            0.1s 
 ✔ Container test-245-1_zero3_1   Removed                                                                                                                                                            0.0s 
 ✔ Container test-245-1_alpha6_1  Removed                                                                                                                                                            0.1s 
 ✔ Container test-245-1_zero2_1   Removed                                                                                                                                                            0.0s 
 ✔ Container test-245-1_alpha5_1  Removed                                                                                                                                                            0.0s 
 ✔ Container test-245-1_zero1_1   Removed                                                                                                                                                            0.1s 
 ✔ Container test-245-1_alpha4_1  Removed                                                                                                                                                            0.1s 
 ✔ Container test-245-1_alpha3_1  Removed                                                                                                                                                            0.0s 
 ✔ Container test-245-1_alpha2_1  Removed                                                                                                                                                            0.0s 
 ✔ Container test-245-1_alpha1_1  Removed                                                                                                                                                            0.0s 
 ✔ Network test-245-1_default     Removed                                                                                                                                                            0.2s 
CLUSTER AND NETWORK REMOVED: test-245-1
TIMELINE starting at 8:09:28 PM
[   10s]   [1] DONE took: 6s
Got error: while running command: [go test -failfast -v -tags=integration -timeout 30m github.com/dgraph-io/dgraph/ee/acl], error: context canceled.
Tests FAILED.
make: *** [test] Error 1

Could you please advise on how to fix the problem?

[AlexeiVitenko]

I faced the similar issue running tests on Windows machine (with Ubuntu 22.04 image, provided by WSL2). That's how I found this topic.
I tried to break down test task into to smaller tasks. Running that compose command in terminal for example. (It's my first experience both with docker & WSL, so solution could be not optimal :) )
What I found:

1. GOPATH. Compose is expecting reference to some accessible directory where it could store go packages and put dgraph binary. Real gopath in /usr/local didn't work. So I've just created directory on the same level as cloned dgraph repo (and added 'bin' directory inside it). And exported it's full path to env variable export GOPATH=/mnt/C/....
2. Networking. It's WSL2-speciefic issue. Snaps are not working. Docker containers have issues connecting to each other. Host-wsl network are not possible by default. Just enabled network mirroring in .wslconfig. Solved all the issues for dev environment.
3. Linking go runtime with libc. Ubuntu 22.04 image has version 2.35, dgraph binary is expecting 2.32-2.34. Quick fix is here: [BUG]: Docker images don't work when built locally on a 22.04 ubuntu machine #8701 (comment) Just change the base image from 20.04 to 22.04

I managed to launch tests and they are passing up to 12th in the best case. Sometimes failed on first. But I think it's another issue.

[github-actions]

This issue has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.