opendev
/
gerrit
Code Issues Proposed changes
gerrit/polygerrit-ui
History
Wyatt Allen 558a2afbd2 Serve PolyGerrit index.html from a Soy template 
Rather than serving a static file, serve the PolyGerrit index HTML
document from a Soy template. In this way, the path to load PG
dependencies can be safely parameterized in two ways:

* If Gerrit is not running on the root of the domain (e.g. listening on
  https://example.com/my-gerrit/) the path component of the Canonical
  Web URL is used to load PG dependencies.

  Instead of /elements/gr-app.js off the root of the domain it uses
  /my-gerrit/elements/gr-app.js

* If the PolyGerrit static resources are to be served from a CDN rather
  than the Gerrit WAR, the `cdnPath` config in the [gerrit] section can
  be used.

  For example, if the server config says ...

  [gerrit]
    cdnPath = http://my-cdn.com/pg/version/123

  ... then it uses the following style of path for PG dependencies.

  http://my-cdn.com/pg/version/123/my-gerrit/elements/gr-app.js

  If a CDN-path is configured, it supersedes subdirectories appearing
  in the Canonical-Web-URL for this purpose.

Feature: Issue 5845
Change-Id: I2b2d704fe33c90ea2f2a2183fc79897642a48175
(cherry picked from commit 414659c792)
 		2017-04-03 18:12:54 +00:00
..
app Serve PolyGerrit index.html from a Soy template 2017-04-03 18:12:54 +00:00
.gitattributes Add the skeleton of a new UI based on Polymer, PolyGerrit 2015-11-09 22:01:28 +00:00
.gitignore Serve fonts from Gerrit instead of Google Fonts. 2016-04-01 13:11:02 -04:00
BUILD Bazel: Reformat build files 2016-12-07 11:33:07 +00:00
README.md Fix polygerrit.war path when building PolyGerrit with Bazel 2017-01-23 14:38:00 -08:00
run-server.sh Don't hardcode /bin/bash 2017-03-03 08:12:45 -06:00
server.go Add CLI flag to run-server.go for local plugins 2017-02-09 09:09:27 -08:00
wct.conf.js Add the skeleton of a new UI based on Polymer, PolyGerrit 2015-11-09 22:01:28 +00:00

README.md

PolyGerrit

Installing Node.js

# Debian/Ubuntu
sudo apt-get install nodejs-legacy

# OS X with Homebrew
brew install node

All other platforms: download from nodejs.org.

Installing Bazel

Follow the instructions here to get and install Bazel.

Local UI, Production Data

This is a quick and easy way to test your local changes against real data. Unfortunately, you can't sign in, so testing certain features will require you to use the "test data" technique described below.

Installing go

This is required for running the run-server.sh script below.

# Debian/Ubuntu
sudo apt-get install golang

# OS X with Homebrew
brew install go

All other platforms: download from golang.org

Then add go to your path:

PATH=$PATH:/usr/local/go/bin

Running the server

To test the local UI against gerrit-review.googlesource.com:

./run-server.sh

Then visit http://localhost:8081

Local UI, Test Data

One-time setup:

  1. Build Gerrit
  2. Set up a local test site. Docs here and here.

When your project is set up and works using the classic UI, run a test server that serves PolyGerrit:

bazel build polygerrit && \
java -jar bazel-bin/polygerrit.war daemon --polygerrit-dev \
-d ../gerrit_testsite --console-log --show-stack-trace

Running Tests

One-time setup:

# Debian/Ubuntu
sudo apt-get install npm

# OS X with Homebrew
brew install npm

# All platforms (including those above)
sudo npm install -g web-component-tester

Run all web tests:

./polygerrit-ui/app/run_test.sh

If you need to pass additional arguments to wct:

WCT_ARGS='-p --some-flag="foo bar"' ./polygerrit-ui/app/run_test.sh

For interactively working on a single test file, do the following:

./polygerrit-ui/run-server.sh

Then visit http://localhost:8081/elements/foo/bar_test.html

Style guide

We follow the Google JavaScript Style Guide with a few exceptions. When in doubt, remain consistent with the code around you.