Add Cockpit Starter Kit infrastructure

* Based on commit b2379f78.

web/.babelrc.json

@@ -0,0 +1,14 @@
+{
+ "presets": [
+ ["@babel/env", {
+ "targets": {
+ "chrome": "57",
+ "firefox": "52",
+ "safari": "10.3",
+ "edge": "16",
+ "opera": "44"
+ }
+ }],
+ "@babel/preset-react"
+ ]
+}

web/.eslintignore

@@ -1 +1,2 @@
-src/lib/cockpit.js
+node_modules/*
+src/lib/*

web/.eslintrc.json

@@ -1,28 +1,52 @@
 {
- "env": {
- "browser": true,
- "es2021": true,
- "jest": true
- },
- "extends": [
- "eslint:recommended",
- "plugin:react/recommended",
- "plugin:prettier/recommended"
- ],
- "parserOptions": {
- "ecmaFeatures": {
- "jsx": true
+ "root": true,
+ "env": {
+ "browser": true,
+ "es6": true
  },
- "ecmaVersion": "latest",
- "sourceType": "module"
- },
- "plugins": ["react"],
- "rules": {
- "react/prop-types": ["off"]
- },
- "settings": {
- "react": {
- "version": "detect"
+ "extends": ["eslint:recommended", "standard", "standard-jsx", "standard-react"],
+ "parser": "@babel/eslint-parser",
+ "parserOptions": {
+ "ecmaVersion": "7",
+ "ecmaFeatures": {
+ "jsx": true
+ },
+ "sourceType": "module"
+ },
+ "plugins": ["flowtype", "react", "react-hooks"],
+ "rules": {
+ "indent": ["error", 4,
+ {
+ "ObjectExpression": "first",
+ "CallExpression": {"arguments": "first"},
+ "MemberExpression": 2,
+ "ignoredNodes": [ "JSXAttribute" ]
+ }],
+ "newline-per-chained-call": ["error", { "ignoreChainWithDepth": 2 }],
+ "no-var": "error",
+ "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
+ "prefer-promise-reject-errors": ["error", { "allowEmptyReject": true }],
+ "react/jsx-indent": ["error", 4],
+ "semi": ["error", "always", { "omitLastInOneLineBlock": true }],
+
+ "react-hooks/rules-of-hooks": "error",
+ "react-hooks/exhaustive-deps": "error",
+
+ "camelcase": "off",
+ "comma-dangle": "off",
+ "curly": "off",
+ "jsx-quotes": "off",
+ "key-spacing": "off",
+ "no-console": "off",
+ "quotes": "off",
+ "react/jsx-curly-spacing": "off",
+ "react/jsx-indent-props": "off",
+ "react/prop-types": "off",
+ "space-before-function-paren": "off",
+ "standard/no-callback-literal": "off"
+ },
+ "globals": {
+ "require": false,
+ "module": false
  }
- }
 }

web/.gitignore

@@ -1,26 +1,18 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# production
-/dist
-
-# misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Web interface logs directory
-.log
+*~
+*.retry
+*.tar.xz
+*.rpm
+node_modules/
+dist/
+/*.spec
+/.vagrant
+package-lock.json
+Test*FAIL*
+/bots
+test/common/
+test/images/
+# src/lib/
+*.pot
+POTFILES*
+tmp/
+/po/LINGUAS

web/Makefile

@@ -0,0 +1,199 @@
+# extract name from package.json
+PACKAGE_NAME := $(shell awk '/"name":/ {gsub(/[",]/, "", $$2); print $$2}' package.json)
+RPM_NAME := cockpit-$(PACKAGE_NAME)
+VERSION := $(shell T=$$(git describe 2>/dev/null) || T=1; echo $$T | tr '-' '.')
+ifeq ($(TEST_OS),)
+TEST_OS = centos-8-stream
+endif
+export TEST_OS
+TARFILE=$(RPM_NAME)-$(VERSION).tar.xz
+NODE_CACHE=$(RPM_NAME)-node-$(VERSION).tar.xz
+SPEC=$(RPM_NAME).spec
+APPSTREAMFILE=org.cockpit-project.$(PACKAGE_NAME).metainfo.xml
+VM_IMAGE=$(CURDIR)/test/images/$(TEST_OS)
+# stamp file to check if/when npm install ran
+NODE_MODULES_TEST=package-lock.json
+# one example file in dist/ from webpack to check if that already ran
+WEBPACK_TEST=dist/manifest.json
+# one example file in src/lib to check if it was already checked out
+LIB_TEST=src/lib/cockpit-po-plugin.js
+# common arguments for tar, mostly to make the generated tarballs reproducible
+TAR_ARGS = --sort=name --mtime "@$(shell git show --no-patch --format='%at')" --mode=go=rX,u+rw,a-s --numeric-owner --owner=0 --group=0
+
+all: $(WEBPACK_TEST)
+
+#
+# i18n
+#
+
+LINGUAS=$(basename $(notdir $(wildcard po/*.po)))
+
+po/$(PACKAGE_NAME).js.pot:
+ xgettext --default-domain=$(PACKAGE_NAME) --output=$@ --language=C --keyword= \
+ --keyword=_:1,1t --keyword=_:1c,2,2t --keyword=C_:1c,2 \
+ --keyword=N_ --keyword=NC_:1c,2 \
+ --keyword=gettext:1,1t --keyword=gettext:1c,2,2t \
+ --keyword=ngettext:1,2,3t --keyword=ngettext:1c,2,3,4t \
+ --keyword=gettextCatalog.getString:1,3c --keyword=gettextCatalog.getPlural:2,3,4c \
+ --from-code=UTF-8 $$(find src/ \( -name '*.js' -o -name '*.jsx' \) \! -path 'src/lib/*')
+
+po/$(PACKAGE_NAME).html.pot: $(NODE_MODULES_TEST)
+ po/html2po -o $@ $$(find src -name '*.html' \! -path 'src/lib/*')
+
+po/$(PACKAGE_NAME).manifest.pot: $(NODE_MODULES_TEST)
+ po/manifest2po src/manifest.json -o $@
+
+po/$(PACKAGE_NAME).metainfo.pot: $(APPSTREAMFILE)
+ xgettext --default-domain=$(PACKAGE_NAME) --output=$@ $<
+
+po/$(PACKAGE_NAME).pot: po/$(PACKAGE_NAME).html.pot po/$(PACKAGE_NAME).js.pot po/$(PACKAGE_NAME).manifest.pot po/$(PACKAGE_NAME).metainfo.pot
+ msgcat --sort-output --output-file=$@ $^
+
+po/LINGUAS:
+ echo $(LINGUAS) | tr ' ' '\n' > $@
+
+# Update translations against current PO template
+update-po: po/$(PACKAGE_NAME).pot
+ for lang in $(LINGUAS); do \
+ msgmerge --output-file=po/$$lang.po po/$$lang.po $<; \
+ done
+
+#
+# Build/Install/dist
+#
+
+%.spec: packaging/%.spec.in
+ sed -e 's/%{VERSION}/$(VERSION)/g' $< > $@
+
+$(WEBPACK_TEST): $(NODE_MODULES_TEST) $(LIB_TEST) $(shell find src/ -type f) package.json webpack.config.js
+ NODE_ENV=$(NODE_ENV) node_modules/.bin/webpack
+
+watch:
+ NODE_ENV=$(NODE_ENV) node_modules/.bin/webpack --watch
+
+clean:
+ rm -rf dist/
+ rm -f $(SPEC)
+ rm -f po/LINGUAS
+
+install: $(WEBPACK_TEST) po/LINGUAS
+ mkdir -p $(DESTDIR)/usr/share/cockpit/$(PACKAGE_NAME)
+ cp -r dist/* $(DESTDIR)/usr/share/cockpit/$(PACKAGE_NAME)
+ mkdir -p $(DESTDIR)/usr/share/metainfo/
+ msgfmt --xml -d po \
+ --template $(APPSTREAMFILE) \
+ -o $(DESTDIR)/usr/share/metainfo/$(APPSTREAMFILE)
+
+# this requires a built source tree and avoids having to install anything system-wide
+devel-install: $(WEBPACK_TEST)
+ mkdir -p ~/.local/share/cockpit
+ ln -s `pwd`/dist ~/.local/share/cockpit/$(PACKAGE_NAME)
+
+# assumes that there was symlink set up using the above devel-install target,
+# and removes it
+devel-uninstall:
+ rm -f ~/.local/share/cockpit/$(PACKAGE_NAME)
+
+print-version:
+ @echo "$(VERSION)"
+
+dist: $(TARFILE)
+ @ls -1 $(TARFILE)
+
+# when building a distribution tarball, call webpack with a 'production' environment
+# we don't ship node_modules for license and compactness reasons; we ship a
+# pre-built dist/ (so it's not necessary) and ship packge-lock.json (so that
+# node_modules/ can be reconstructed if necessary)
+$(TARFILE): export NODE_ENV=production
+$(TARFILE): $(WEBPACK_TEST) $(SPEC)
+ if type appstream-util >/dev/null 2>&1; then appstream-util validate-relax --nonet *.metainfo.xml; fi
+ touch -r package.json $(NODE_MODULES_TEST)
+ touch dist/*
+ tar --xz $(TAR_ARGS) -cf $(TARFILE) --transform 's,^,$(RPM_NAME)/,' \
+ --exclude packaging/$(SPEC).in --exclude node_modules \
+ $$(git ls-files) src/lib package-lock.json $(SPEC) dist/
+
+$(NODE_CACHE): $(NODE_MODULES_TEST)
+ tar --xz $(TAR_ARGS) -cf $@ node_modules
+
+node-cache: $(NODE_CACHE)
+
+# convenience target for developers
+srpm: $(TARFILE) $(NODE_CACHE) $(SPEC)
+ rpmbuild -bs \
+ --define "_sourcedir `pwd`" \
+ --define "_srcrpmdir `pwd`" \
+ $(SPEC)
+
+# convenience target for developers
+rpm: $(TARFILE) $(NODE_CACHE) $(SPEC)
+ mkdir -p "`pwd`/output"
+ mkdir -p "`pwd`/rpmbuild"
+ rpmbuild -bb \
+ --define "_sourcedir `pwd`" \
+ --define "_specdir `pwd`" \
+ --define "_builddir `pwd`/rpmbuild" \
+ --define "_srcrpmdir `pwd`" \
+ --define "_rpmdir `pwd`/output" \
+ --define "_buildrootdir `pwd`/build" \
+ $(SPEC)
+ find `pwd`/output -name '*.rpm' -printf '%f\n' -exec mv {} . \;
+ rm -r "`pwd`/rpmbuild"
+ rm -r "`pwd`/output" "`pwd`/build"
+
+# build a VM with locally built distro pkgs installed
+# disable networking, VM images have mock/pbuilder with the common build dependencies pre-installed
+$(VM_IMAGE): $(TARFILE) $(NODE_CACHE) bots test/vm.install
+ bots/image-customize --no-network --fresh \
+ --upload $(NODE_CACHE):/var/tmp/ --build $(TARFILE) \
+ --script $(CURDIR)/test/vm.install $(TEST_OS)
+
+# convenience target for the above
+vm: $(VM_IMAGE)
+ echo $(VM_IMAGE)
+
+# convenience target to print the filename of the test image
+print-vm:
+ echo $(VM_IMAGE)
+
+# convenience target to setup all the bits needed for the integration tests
+# without actually running them
+prepare-check: $(NODE_MODULES_TEST) $(VM_IMAGE) test/common
+
+# run the browser integration tests; skip check for SELinux denials
+# this will run all tests/check-* and format them as TAP
+check: prepare-check
+ TEST_AUDIT_NO_SELINUX=1 test/common/run-tests
+
+# checkout Cockpit's bots for standard test VM images and API to launch them
+# must be from main, as only that has current and existing images; but testvm.py API is stable
+# support CI testing against a bots change
+bots:
+ git clone --quiet --reference-if-able $${XDG_CACHE_HOME:-$$HOME/.cache}/cockpit-project/bots https://github.com/cockpit-project/bots.git
+ if [ -n "$$COCKPIT_BOTS_REF" ]; then git -C bots fetch --quiet --depth=1 origin "$$COCKPIT_BOTS_REF"; git -C bots checkout --quiet FETCH_HEAD; fi
+ @echo "checked out bots/ ref $$(git -C bots rev-parse HEAD)"
+
+# checkout Cockpit's test API; this has no API stability guarantee, so check out a stable tag
+# when you start a new project, use the latest release, and update it from time to time
+test/common:
+ flock Makefile sh -ec '\
+ git fetch --depth=1 https://github.com/cockpit-project/cockpit.git 265; \
+ git checkout --force FETCH_HEAD -- test/common; \
+ git reset test/common'
+
+# checkout Cockpit's PF/React/build library; again this has no API stability guarantee, so check out a stable tag
+$(LIB_TEST):
+ flock Makefile sh -ec '\
+ git fetch --depth=1 https://github.com/cockpit-project/cockpit.git 265; \
+ git checkout --force FETCH_HEAD -- ../pkg/lib; \
+ git reset -- ../pkg/lib'
+ mv ../pkg/lib/cockpit-po-plugin.js ../pkg/lib/cockpit-rsync-plugin.js src/lib && rm -r ../pkg
+
+$(NODE_MODULES_TEST): package.json
+ # if it exists already, npm install won't update it; force that so that we always get up-to-date packages
+ rm -f package-lock.json
+ # unset NODE_ENV, skips devDependencies otherwise
+ env -u NODE_ENV npm install
+ env -u NODE_ENV npm prune
+
+.PHONY: all clean install devel-install print-version dist node-cache rpm check vm update-po print-vm devel-uninstall

web/org.opensuse.d-installer.metainfo.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="addon">
+ <id>org.opensuse.d-installer</id>
+ <metadata_license>CC0-1.0</metadata_license>
+ <name>D-Installer</name>
+ <summary>D-Installer cockpit module</summary>
+ <description>
+ <p>
+ Cockpit module for D-Installer, a YaST-based installation tool.
+ </p>
+ </description>
+ <extends>org.cockpit_project.cockpit</extends>
+ <launchable type="cockpit-manifest">d-installer</launchable>
+ <url type="homepage">https://github.com/yast/d-installer</url>
+ <url type="bugtracker">https://github.com/yast/d-installer</url>
+ <update_contact>yast-devel_AT_lists.opensuse.org</update_contact>
+</component>