mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-09-15 12:47:56 +08:00
7d4d360e52
* Cleanup the backend-dev convenience method * Add the frontend_dev convenience method frontend_dev is a soup-to-nuts convenience method for setting up the FE development environment with node running a the client code on port 3000 with the a separate cellxgene package serving the API over port 5005 in the background. The script can be run from Finder. * Update the developer scripts documentation * Remove the 'test' make target in the client Makefile Rationale: * Given how long the smoke tests take to run, it is unlikely that developers will want to run all tests together. * It is unlikely that developers will have set up the backend server properly for the tests to pass. * Available commands should be safe-ish and not lend themselves to confusing errors. * You can still group tests by concatenating them in a make command, as in `make unit-test smoke-test`. * This target isn't used in any of our CI pipelines -- KISS. * Some version of python3... * Minor typos in docs * Respond to feedback from @bkmartinjr * Make adjustments so that DATASET path is predictable * Simplify environment defaults a bit
84 lines
1.9 KiB
Makefile
84 lines
1.9 KiB
Makefile
include ../common.mk
|
|
# https://stackoverflow.com/a/14777895/9587410
|
|
ifeq ($(shell uname),Darwin) # is Windows_NT on XP, 2000, 7, Vista, 10...
|
|
IS_DARWIN := "true"
|
|
endif
|
|
|
|
ANNOTATIONS := $(if $(ANNOTATIONS),$(ANNOTATIONS),../server/test/test_datasets/pbmc3k-annotations.csv)
|
|
ANNOTATIONS_FILENAME := $(shell basename $(ANNOTATIONS))
|
|
|
|
# Packaging
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf node_modules
|
|
|
|
.PHONY: ci
|
|
ci:
|
|
npm ci
|
|
|
|
.PHONY: install
|
|
install:
|
|
npm install
|
|
|
|
.PHONY: build
|
|
build:
|
|
npm run build
|
|
|
|
# Formatting code
|
|
|
|
.PHONY: lint
|
|
lint:
|
|
npx eslint .
|
|
|
|
.PHONY: lint-diff
|
|
lint-diff:
|
|
# Get client diff against master, find all js/jsx files, remove the client prefex, run eslinst against result
|
|
git diff --name-only --diff-filter=d origin/master...HEAD -- ../client/ | grep -E "(.*)\.(jsx|js)" | sed "s/client\///" | $(if $(IS_DARWIN),xargs ./node_modules/.bin/eslint,xargs -r ./node_modules/.bin/eslint)
|
|
|
|
|
|
# Development convenience methods
|
|
.PHONY: start-frontend
|
|
start-frontend:
|
|
node server/development.js
|
|
|
|
.PHONY: e2e
|
|
e2e:
|
|
node node_modules/jest/bin/jest.js \
|
|
--verbose false \
|
|
--config __tests__/e2e/e2eJestConfig.json \
|
|
e2e/e2e.test.js
|
|
|
|
.PHONY: e2e-annotations
|
|
e2e-annotations:
|
|
node node_modules/jest/bin/jest.js \
|
|
--verbose false \
|
|
--config __tests__/e2e/e2eJestConfig.json \
|
|
e2e/e2eAnnotations.test.js
|
|
|
|
.PHONY: smoke-test
|
|
smoke-test:
|
|
start_server_and_test \
|
|
'CXG_OPTIONS="--disable-annotations" $(MAKE) start-server' \
|
|
$(CXG_SERVER_PORT) \
|
|
'$(MAKE) e2e'
|
|
|
|
|
|
.PHONY: smoke-test-annotations
|
|
smoke-test-annotations:
|
|
$(eval TMP_DIR := $(shell mktemp -d /tmp/cellxgene_XXXXXX))
|
|
cp $(ANNOTATIONS) $(TMP_DIR)/ && \
|
|
start_server_and_test \
|
|
'CXG_OPTIONS="--annotations-file $(TMP_DIR)/$(ANNOTATIONS_FILENAME)" $(MAKE) start-server' \
|
|
$(CXG_SERVER_PORT) \
|
|
'$(MAKE) e2e-annotations'
|
|
rm -rf $(TMP_DIR)
|
|
|
|
.PHONY: unit-test
|
|
unit-test:
|
|
node node_modules/jest/bin/jest.js \
|
|
--testPathIgnorePatterns e2e
|
|
|
|
# pass remaining commands through to npm run
|
|
%:
|
|
npm run $(*)
|