Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve test failure directions #4902

Merged
merged 7 commits into from
Apr 7, 2020
Merged

Improve test failure directions #4902

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
09fc08d
Move .sdist-requirements target
blag Apr 3, 2020
03485ec
Split out .requirements target from requirements target
blag Apr 3, 2020
fda3c26
Split out part of check-requirements into .check-requirements
blag Apr 3, 2020
e1abbf7
Give directions on how to update requirements properly
blag Apr 3, 2020
bd18848
Add targets for checking the sdsist-requirements were updated properly
blag Apr 3, 2020
a9c8786
Integrate new check-sdist-requirements target into check targets
blag Apr 3, 2020
9a38225
Merge branch 'master' into better-test-failure-directions
blag Apr 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 77 additions & 35 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ play:
@echo

.PHONY: check
check: check-requirements flake8 checklogs
check: check-requirements check-sdist-requirements flake8 checklogs

# NOTE: We pass --no-deps to the script so we don't install all the
# package dependencies which are already installed as part of "requirements"
Expand All @@ -161,13 +161,54 @@ install-runners:
done

.PHONY: check-requirements
check-requirements: requirements
.check-requirements:
@echo
@echo "============== CHECKING REQUIREMENTS =============="
@echo
# Update requirements and then make sure no files were changed
git status -- *requirements.txt */*requirements.txt | grep -q "nothing to commit"
@echo "All requirements files up-to-date!"
git status -- *requirements.txt */*requirements.txt | grep -q "nothing to commit" || { \
echo "It looks like you directly modified a requirements.txt file, an"; \
echo "in-requirements.txt file, or fixed-requirements.txt without running:"; \
echo ""; \
echo " make .requirements"; \
echo ""; \
echo "Please update all of the requirements.txt files by running that command"; \
echo "and committing all of the changed files. You can quickly check the results"; \
echo "with:"; \
echo ""; \
echo " make .check-requirements"; \
echo ""; \
exit 1; \
}
@echo "All requirements files are up-to-date!"

.PHONY: check-requirements
check-requirements: .requirements .check-requirements

.PHONY: .check-sdist-requirements
.check-sdist-requirements:
@echo
@echo "============== CHECKING SDIST REQUIREMENTS =============="
@echo
# Update requirements and then make sure no files were changed
git status -- */dist_utils.py contrib/runners/*/dist_utils.py | grep -q "nothing to commit" || { \
echo "It looks like you directly modified a dist_utils.py, or the source "; \
echo "scripts/dist_utils.py file without running:"; \
echo ""; \
echo " make .sdist-requirements"; \
echo ""; \
echo "Please update all of the dist_utils.py files by running that command"; \
echo "and committing all of the changed files. You can quickly check the results"; \
echo "with:"; \
echo ""; \
echo " make .check-sdist-requirements"; \
echo ""; \
exit 1; \
}
@echo "All dist_utils.py files are up-to-date!"

.PHONY: check-sdist-requirements
check-sdist-requirements: .sdist-requirements .check-sdist-requirements

.PHONY: check-python-packages
check-python-packages:
Expand Down Expand Up @@ -437,21 +478,23 @@ distclean: clean
@echo
rm -rf $(VIRTUALENV_DIR)

.PHONY: requirements
requirements: virtualenv .sdist-requirements install-runners
@echo
@echo "==================== requirements ===================="
@echo
# If you update these versions, make sure you also update the versions in the
# .st2client-install-check target and .travis.yml to match
# Make sure we use latest version of pip
$(VIRTUALENV_DIR)/bin/pip --version
$(VIRTUALENV_DIR)/bin/pip install --upgrade "pip==20.0.2"
# setuptools >= 41.0.1 is required for packs.install in dev envs
# setuptools >= 42 is required so setup.py install respects dependencies' python_requires
$(VIRTUALENV_DIR)/bin/pip install --upgrade "setuptools==44.1.0"
$(VIRTUALENV_DIR)/bin/pip install --upgrade "pbr==5.4.3" # workaround for pbr issue
.PHONY: .sdist-requirements
.sdist-requirements:
# Copy over shared dist utils module which is needed by setup.py
@for component in $(COMPONENTS_WITH_RUNNERS); do\
cp -f ./scripts/dist_utils.py $$component/dist_utils.py;\
scripts/write-headers.sh $$component/dist_utils.py || break;\
done

# Copy over CHANGELOG.RST, CONTRIBUTING.RST and LICENSE file to each component directory
#@for component in $(COMPONENTS_TEST); do\
# test -s $$component/README.rst || cp -f README.rst $$component/; \
# cp -f CONTRIBUTING.rst $$component/; \
# cp -f LICENSE $$component/; \
#done

.PHONY: .requirements
.requirements: virtualenv
# Generate all requirements to support current CI pipeline.
$(VIRTUALENV_DIR)/bin/python scripts/fixate-requirements.py --skip=virtualenv,virtualenv-osx -s st2*/in-requirements.txt contrib/runners/*/in-requirements.txt -f fixed-requirements.txt -o requirements.txt

Expand All @@ -467,6 +510,21 @@ requirements: virtualenv .sdist-requirements install-runners

@echo "==========================================================="

.PHONY: requirements
requirements: virtualenv .requirements .sdist-requirements install-runners
@echo
@echo "==================== requirements ===================="
@echo
# If you update these versions, make sure you also update the versions in the
# .st2client-install-check target and .travis.yml to match
# Make sure we use latest version of pip
$(VIRTUALENV_DIR)/bin/pip --version
$(VIRTUALENV_DIR)/bin/pip install --upgrade "pip>=19.3.1"
# setuptools >= 41.0.1 is required for packs.install in dev envs
# setuptools >= 42 is required so setup.py install respects dependencies' python_requires
$(VIRTUALENV_DIR)/bin/pip install --upgrade "setuptools>=42"
Comment on lines +522 to +525
Copy link
Member

@arm4b arm4b Apr 7, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like with this diff we just relaxed again pinned versions set before

pip==20.0.2
setuptools==44.1.0

$(VIRTUALENV_DIR)/bin/pip install --upgrade "pbr==5.4.3" # workaround for pbr issue

# Fix for Travis CI race
$(VIRTUALENV_DIR)/bin/pip install "six==1.12.0"

Expand Down Expand Up @@ -934,28 +992,12 @@ debs:
$(foreach COM,$(COMPONENTS), pushd $(COM); make deb; popd;)
pushd st2client && make deb && popd

# >>>>
.PHONY: .sdist-requirements
.sdist-requirements:
# Copy over shared dist utils module which is needed by setup.py
@for component in $(COMPONENTS_WITH_RUNNERS); do\
cp -f ./scripts/dist_utils.py $$component/dist_utils.py;\
scripts/write-headers.sh $$component/dist_utils.py || break;\
done

# Copy over CHANGELOG.RST, CONTRIBUTING.RST and LICENSE file to each component directory
#@for component in $(COMPONENTS_TEST); do\
# test -s $$component/README.rst || cp -f README.rst $$component/; \
# cp -f CONTRIBUTING.rst $$component/; \
# cp -f LICENSE $$component/; \
#done


.PHONY: ci
ci: ci-checks ci-unit ci-integration ci-mistral ci-packs-tests

.PHONY: ci-checks
ci-checks: compile .generated-files-check .pylint .flake8 check-requirements .st2client-dependencies-check .st2common-circular-dependencies-check circle-lint-api-spec .rst-check .st2client-install-check check-python-packages
ci-checks: compile .generated-files-check .pylint .flake8 check-requirements check-sdist-requirements .st2client-dependencies-check .st2common-circular-dependencies-check circle-lint-api-spec .rst-check .st2client-install-check check-python-packages

.PHONY: ci-py3-unit
ci-py3-unit:
Expand Down