Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Unverified Commit 949378a0 authored by Markus Heiser's avatar Markus Heiser Committed by GitHub
Browse files

Merge pull request #1900 from return42/issue-1898 

export build variables / support brands
parents 9a2f26d9 1ae39787

.dockerignore

+8 −0
Original line number Diff line number Diff line
@@ -4,6 +4,9 @@ 
*/*/*/*~

*/*/*/*/*~



#

local/



# Git

.git

.gitignore
@@ -36,6 +39,11 @@ robot_report.html 
test_basic/

setup.cfg



# node_modules

node_modules/

*/node_modules/

*/*/node_modules/

*/*/*/node_modules/

*/*/*/*/node_modules/



.tx/
 
 No newline at end of file

.gitignore

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ setup.cfg 
*/*.pyc

*~



node_modules/

/node_modules



.tx/

.travis.yml

+8 −12
Original line number Diff line number Diff line 
language: python

sudo: false

cache:

  - pip

  - npm

  - directories:

    - $HOME/.cache/pip
@@ -10,17 +8,15 @@ addons: 
  firefox: "latest"



install:

  - ./manage.sh install_geckodriver ~/drivers

  - export PATH=~/drivers:$PATH

  - ./manage.sh npm_packages

  - ./manage.sh update_dev_packages

  - pip install codecov

  - make install

  - make gecko.driver

  - make node.env

  - local/py3/bin/pip install codecov

script:

  - ./manage.sh styles

  - ./manage.sh grunt_build

  - ./manage.sh tests

  - make themes

  - make test

after_success:

  - ./manage.sh py_test_coverage

  - make test.coverage

  - codecov



stages:
@@ -44,7 +40,7 @@ jobs: 
      install: true

      script:

        - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin

        - ./manage.sh docker_build push

        - local/py3/bin/activate; ./manage.sh docker_build push

      after_success: true



notifications:

Dockerfile

+2 −1
Original line number Diff line number Diff line
@@ -4,6 +4,7 @@ EXPOSE 8080 
VOLUME /etc/searx

VOLUME /var/log/uwsgi



ARG GIT_URL=unknown

ARG VERSION_GITCOMMIT=unknown

ARG SEARX_GIT_VERSION=unknown
@@ -66,7 +67,7 @@ RUN su searx -c "/usr/bin/python3 -m compileall -q searx"; \ 


# Keep this argument at the end since it change each time

ARG LABEL_DATE=

LABEL maintainer="searx <https://github.com/asciimoo/searx>" \

LABEL maintainer="searx <${GIT_URL}>" \

      description="A privacy-respecting, hackable metasearch engine." \

      version="${SEARX_GIT_VERSION}" \

      org.label-schema.schema-version="1.0" \

Makefile

+138 −23
Original line number Diff line number Diff line
@@ -28,23 +28,27 @@ help: 
	@echo  '  gh-pages  - build docs & deploy on gh-pages branch'

	@echo  '  clean     - drop builds and environments'

	@echo  '  project   - re-build generic files of the searx project'

	@echo  '  buildenv  - re-build environment files (aka brand)'

	@echo  '  themes    - re-build build the source of the themes'

	@echo  '  docker    - build Docker image'

	@echo  '  node.env  - download & install npm dependencies locally'

	@echo  ''

	@$(MAKE) -s -f utils/makefile.include make-help

	@echo  ''

	@$(MAKE) -s -f utils/makefile.python python-help



PHONY += install

install: pyenvinstall

install: buildenv pyenvinstall



PHONY += uninstall

uninstall: pyenvuninstall



PHONY += clean

clean: pyclean

clean: pyclean node.clean test.clean

	$(call cmd,common_clean)



PHONY += run

run:  pyenvinstall

run:  buildenv pyenvinstall

	$(Q) ( \

	sed -i -e "s/debug : False/debug : True/g" ./searx/settings.yml ; \

	sleep 2 ; \
@@ -58,11 +62,11 @@ run: pyenvinstall 
# ----



PHONY += docs

docs:  pyenvinstall sphinx-doc

docs:  buildenv pyenvinstall sphinx-doc

	$(call cmd,sphinx,html,docs,docs)



PHONY += docs-live

docs-live:  pyenvinstall sphinx-live

docs-live:  buildenv pyenvinstall sphinx-live

	$(call cmd,sphinx_autobuild,html,docs,docs)



$(GH_PAGES)::
@@ -71,35 +75,146 @@ $(GH_PAGES):: 
# update project files

# --------------------



PHONY += project engines-languages



project: searx/data/engines_languages.json



searx/data/engines_languages.json:  pyenvinstall

	$(PY_ENV_ACT); python utils/fetch_languages.py

	mv engines_languages.json searx/data/engines_languages.json

	mv languages.py searx/languages.py

PHONY += project engines.languages useragents.update buildenv



project: buildenv useragents.update engines.languages



engines.languages:  pyenvinstall

	$(Q)echo "fetch languages .."

	$(Q)$(PY_ENV_ACT); python utils/fetch_languages.py

	$(Q)echo "update searx/data/engines_languages.json"

	$(Q)mv engines_languages.json searx/data/engines_languages.json

	$(Q)echo "update searx/languages.py"

	$(Q)mv languages.py searx/languages.py



useragents.update:  pyenvinstall

	$(Q)echo "Update searx/data/useragents.json with the most recent versions of Firefox."

	$(Q)$(PY_ENV_ACT); python utils/fetch_firefox_version.py



buildenv:

	$(Q)echo "build searx/brand.py"

	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py

	$(Q)echo "ISSUE_URL = 'https://github.com/asciimoo/searx/issues'" >> searx/brand.py

	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py

	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py

	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py

	$(Q)echo "build utils/brand.env"

	$(Q)echo "export GIT_URL='$(GIT_URL)'"  > utils/brand.env

	$(Q)echo "export ISSUE_URL='https://github.com/asciimoo/searx/issues'" >> utils/brand.env

	$(Q)echo "export SEARX_URL='$(SEARX_URL)'" >> utils/brand.env

	$(Q)echo "export DOCS_URL='$(DOCS_URL)'" >> utils/brand.env

	$(Q)echo "export PUBLIC_INSTANCES='https://searx.space'" >> utils/brand.env





# node / npm

# ----------



node.env: buildenv

	$(Q)./manage.sh npm_packages



node.clean:

	$(Q)echo "CLEAN     locally installed npm dependencies"

	$(Q)rm -rf \

	  ./node_modules  \

	  ./package-lock.json \

	  ./searx/static/themes/oscar/package-lock.json \

	  ./searx/static/themes/oscar/node_modules \

	  ./searx/static/themes/simple/package-lock.json \

	  ./searx/static/themes/simple/node_modules



# build themes

# ------------



PHONY += themes.bootstrap themes themes.oscar themes.simple themes.legacy themes.courgette themes.pixart

themes: buildenv themes.bootstrap themes.oscar themes.simple themes.legacy themes.courgette themes.pixart



quiet_cmd_lessc = LESSC     $3

      cmd_lessc = PATH="$$(npm bin):$$PATH" \

	lessc --clean-css="--s1 --advanced --compatibility=ie9" "searx/static/$2" "searx/static/$3"



quiet_cmd_grunt = GRUNT     $2

      cmd_grunt = PATH="$$(npm bin):$$PATH" \

	grunt --gruntfile  "$2"



themes.oscar:

	$(Q)echo '[!] build oscar theme'

	$(call cmd,grunt,searx/static/themes/oscar/gruntfile.js)



themes.simple:

	$(Q)echo '[!] build simple theme'

	$(call cmd,grunt,searx/static/themes/simple/gruntfile.js)



themes.legacy:

	$(Q)echo '[!] build legacy theme'

	$(call cmd,lessc,themes/legacy/less/style-rtl.less,themes/legacy/css/style-rtl.css)

	$(call cmd,lessc,themes/legacy/less/style.less,themes/legacy/css/style.css)



themes.courgette:

	$(Q)echo '[!] build courgette theme'

	$(call cmd,lessc,themes/courgette/less/style.less,themes/courgette/css/style.css)

	$(call cmd,lessc,themes/courgette/less/style-rtl.less,themes/courgette/css/style-rtl.css)



themes.pixart:

	$(Q)echo '[!] build pixart theme'

	$(call cmd,lessc,themes/pix-art/less/style.less,themes/pix-art/css/style.css)



themes.bootstrap:

	$(call cmd,lessc,less/bootstrap/bootstrap.less,css/bootstrap.min.css)





# docker

# ------



PHONY += docker

docker: buildenv

	$(Q)./manage.sh docker_build



# gecko

# -----



PHONY += gecko.driver

gecko.driver:

	$(PY_ENV_ACT); ./manage.sh install_geckodriver



# test

# ----



PHONY += test test.pylint test.pep8 test.unit test.robot

PHONY += test test.pylint test.pep8 test.unit test.coverage test.robot



test: test.pylint test.pep8 test.unit test.robot

test: buildenv test.pylint test.pep8 test.unit gecko.driver test.robot



# TODO: balance linting with pylint

test.pylint: pyenvinstall

	$(call cmd,pylint,searx/preferences.py)

	$(call cmd,pylint,searx/testing.py)

	$(call cmd,pylint,\

		searx/preferences.py \

		searx/testing.py \

	)



# ignored rules:

#  E402 module level import not at top of file

#  W503 line break before binary operator



test.pep8: pyenvinstall

	$(PY_ENV_ACT); ./manage.sh pep8_check

	@echo "TEST      pep8"

	$(Q)$(PY_ENV_ACT); pep8 --exclude=searx/static --max-line-length=120 --ignore "E402,W503" searx tests



test.unit: pyenvinstall

	$(PY_ENV_ACT); ./manage.sh unit_tests



test.robot: pyenvinstall

	$(PY_ENV_ACT); ./manage.sh install_geckodriver

	$(PY_ENV_ACT); ./manage.sh robot_tests

	@echo "TEST      tests/unit"

	$(Q)$(PY_ENV_ACT); python -m nose2 -s tests/unit



test.coverage:  pyenvinstall

	@echo "TEST      unit test coverage"

	$(Q)$(PY_ENV_ACT); \

	python -m nose2 -C --log-capture --with-coverage --coverage searx -s tests/unit \

	&& coverage report \

	&& coverage html \



test.robot: pyenvinstall gecko.driver

	@echo "TEST      robot"

	$(Q)$(PY_ENV_ACT); PYTHONPATH=. python searx/testing.py robot



test.clean:

	@echo "CLEAN     intermediate test stuff"

	$(Q)rm -rf geckodriver.log .coverage coverage/



.PHONY: $(PHONY)