Details

Reviewers

Group Reviewers

Commits

rDWAPPS2d0ef127c5da: Move static folder out of the Python tree

Summary

It does not contain Python files but rather Javascript and CSS source files generated by webpack
but also image files and fonts. So it seems a better practice to move this folder at the root of the repository.

That diff moves the folder to the root of the repository and fixes the paths referencing it.

In order to generate the same distribution wheel as before, I added a little hack
in setup.py in order to add the static folder in the swh/web directory: a
symlink is created before calling the setup function and removed afterwards.

~~I do not really like that but I did not find another way to do so.~~

Update: No more dirty hack, I managed to use data_files from setuptools

After this change, static assets will be deployed to /usr/share/swh/web/static/ in production
environment so the puppet configuration will have to be updated before deployment.

Related to T2155

Diff Detail

Repository

rDWAPPS Web applications

Branch

move-assets-and-static

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 10051
Build 14880: Cypress tests for swh-web diffs	Jenkins
Build 14879: tox-on-jenkins	Jenkins
Build 14878: arc lint + arc unit

Event Timeline

anlambert created this revision.Jan 10 2020, 3:02 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptJan 10 2020, 3:02 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/873/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/873/console

Harbormaster failed remote builds in B10033: Diff 8931!Jan 10 2020, 3:05 PM

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/481/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/481/console

Update: Fix tests execution with tox

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/874/ for more details.

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/482/ for more details.

Harbormaster completed remote builds in B10036: Diff 8934.Jan 10 2020, 3:44 PM

In order to generate the same distribution wheel as before, I added a little hack
in setup.py in order to add the static folder in the swh/web directory: a
symlink is created before calling the setup function and removed afterwards.

I do not really like that but I did not find another way to do so.

Let's try if we can use [[ https://docs.python.org/3/distutils/setupscript.html#installing-additional-files | data_files ]] from setuptools instead.

Update:

use data_files parameter from setuptools to bundle static assets generated by webpack instead of using a dirty hack in setup.py

do not move the assets folder after all as the files are not generated and it will be easier to grep its content

anlambert retitled this revision from Move assets and static folders out of the Python tree to Move static folder out of the Python tree.Jan 10 2020, 5:49 PM

anlambert edited the summary of this revision. (Show Details)

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/875/ for more details.

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/483/ for more details.

Harbormaster completed remote builds in B10043: Diff 8941.Jan 10 2020, 5:58 PM

anlambert edited the summary of this revision. (Show Details)Jan 13 2020, 1:48 PM

vlorentz added a subscriber: vlorentz.Jan 13 2020, 1:56 PM

vlorentz added inline comments.

swh/web/tests/conftest.py
58	static_dir = os.path.join(sys.prefix, 'share/swh/web/static')
58	Or `static_dir = pkg_resources.resource_string('swh.web', 'static')`

anlambert added inline comments.Jan 13 2020, 2:05 PM

swh/web/tests/conftest.py
58	Right ! The `pkg_resources` approach does not seem to work after a quick test as it will try to locate resources inside the module folder but data files are located in a different one. So I will go for the classic `os.path.join` approach.

Update: Address @vlorentz comments (use proper paths manipulation)

Build has FAILED

Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/876/
See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/876/console

Harbormaster failed remote builds in B10051: Diff 8948!Jan 13 2020, 2:14 PM

vlorentz added inline comments.Jan 13 2020, 2:18 PM

swh/web/tests/conftest.py
58	There's an extra leading slash

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/484/ for more details.

Update: Remove leading slashes in os.path.join operations.

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/877/ for more details.

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/485/ for more details.

Harbormaster completed remote builds in B10052: Diff 8949.Jan 13 2020, 2:35 PM

vlorentz accepted this revision.Jan 13 2020, 2:42 PM

This revision is now accepted and ready to land.Jan 13 2020, 2:42 PM

Closed by commit rDWAPPS2d0ef127c5da: Move static folder out of the Python tree (authored by anlambert). · Explain WhyJan 13 2020, 2:54 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDWAPPS2d0ef127c5da: Move static folder out of the Python tree.

Move static folder out of the Python treeClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 8948

.gitignore

MANIFEST.in

setup.py

static/img/arrow-up-small.png

static/img/icons/swh-logo-32x32.png

static/img/icons/swh-logo-archive-180x180.png

static/img/icons/swh-logo-archive-192x192.png

static/img/icons/swh-logo-archive-270x270.png

static/img/logos/bitbucket.png

static/img/logos/debian.png

static/img/logos/framagit.png

static/img/logos/github.png

static/img/logos/gitlab.svg

static/img/logos/gitorious.png

static/img/logos/gnu.png

static/img/logos/googlecode.png

static/img/logos/hal.png

static/img/logos/inria.jpg

static/img/logos/npm.png

static/img/logos/pypi.svg

static/img/swh-api.png

static/img/swh-browse.png

static/img/swh-logo-white.svg

static/img/swh-logo.png

static/img/swh-logo.svg

static/img/swh-spinner-small.gif

static/img/swh-spinner.gif

static/img/swh-support.png

static/img/swh-vault.png

static/xml/swh-opensearch.xml

swh/web/assets/config/webpack.config.development.js

swh/web/settings/common.py

swh/web/static/img/arrow-up-small.png

swh/web/static/img/icons/swh-logo-32x32.png

swh/web/static/img/icons/swh-logo-archive-180x180.png

swh/web/static/img/icons/swh-logo-archive-192x192.png

swh/web/static/img/icons/swh-logo-archive-270x270.png

swh/web/static/img/logos/bitbucket.png

swh/web/static/img/logos/debian.png

swh/web/static/img/logos/framagit.png

swh/web/static/img/logos/github.png

swh/web/static/img/logos/gitlab.svg

swh/web/static/img/logos/gitorious.png

swh/web/static/img/logos/gnu.png

swh/web/static/img/logos/googlecode.png

swh/web/static/img/logos/hal.png

swh/web/static/img/logos/inria.jpg

swh/web/static/img/logos/npm.png

swh/web/static/img/logos/pypi.svg

swh/web/static/img/swh-api.png

swh/web/static/img/swh-browse.png

swh/web/static/img/swh-logo-white.svg

swh/web/static/img/swh-logo.png

swh/web/static/img/swh-logo.svg

swh/web/static/img/swh-spinner-small.gif

swh/web/static/img/swh-spinner.gif

swh/web/static/img/swh-support.png

swh/web/static/img/swh-vault.png

swh/web/static/xml/swh-opensearch.xml

swh/web/tests/conftest.py

Move static folder out of the Python tree
ClosedPublic
Actions

Revision Contents
Changeset List