From 58a44349a4f739c27b5dd7308d0d8700ebd8ae65 Mon Sep 17 00:00:00 2001 From: Gerard Braad Date: Sat, 17 Jun 2023 06:17:53 +0000 Subject: [PATCH] Import starterkit and add gitpod --- .cirrus.yml | 22 + .eslintignore | 2 + .eslintrc.json | 48 ++ .fmf/version | 1 + .github/workflows/cockpit-lib-update.yml | 30 ++ .github/workflows/npm-update-pf.yml | 30 ++ .github/workflows/npm-update.yml | 30 ++ .github/workflows/release.yml.disabled | 38 ++ .gitignore | 19 + .gitpod.yml | 33 ++ .gitpod/Dockerfile | 13 + .stylelintrc.json | 38 ++ LICENSE | 502 +++++++++++++++++++ Makefile | 203 ++++++++ README.md | 4 +- build.js | 136 +++++ org.cockpit-project.starter-kit.metainfo.xml | 17 + package.json | 55 ++ packaging/cockpit-starter-kit.spec.in | 55 ++ packit.yaml | 67 +++ plans/all.fmf | 6 + po/de.po | 39 ++ src/app.jsx | 50 ++ src/app.scss | 5 + src/index.html | 34 ++ src/index.js | 30 ++ src/manifest.json | 11 + test/browser/browser.sh | 53 ++ test/browser/main.fmf | 15 + test/browser/run-test.sh | 39 ++ test/check-application | 51 ++ test/reference-image | 1 + test/run | 14 + test/vm.install | 12 + 34 files changed, 1702 insertions(+), 1 deletion(-) create mode 100644 .cirrus.yml create mode 100644 .eslintignore create mode 100644 .eslintrc.json create mode 100644 .fmf/version create mode 100644 .github/workflows/cockpit-lib-update.yml create mode 100644 .github/workflows/npm-update-pf.yml create mode 100644 .github/workflows/npm-update.yml create mode 100644 .github/workflows/release.yml.disabled create mode 100644 .gitignore create mode 100644 .gitpod.yml create mode 100644 .gitpod/Dockerfile create mode 100644 .stylelintrc.json create mode 100644 LICENSE create mode 100644 Makefile create mode 100755 build.js create mode 100644 org.cockpit-project.starter-kit.metainfo.xml create mode 100644 package.json create mode 100644 packaging/cockpit-starter-kit.spec.in create mode 100644 packit.yaml create mode 100644 plans/all.fmf create mode 100644 po/de.po create mode 100644 src/app.jsx create mode 100644 src/app.scss create mode 100644 src/index.html create mode 100644 src/index.js create mode 100644 src/manifest.json create mode 100755 test/browser/browser.sh create mode 100644 test/browser/main.fmf create mode 100755 test/browser/run-test.sh create mode 100755 test/check-application create mode 100644 test/reference-image create mode 100755 test/run create mode 100644 test/vm.install diff --git a/.cirrus.yml b/.cirrus.yml new file mode 100644 index 0000000..93c72b3 --- /dev/null +++ b/.cirrus.yml @@ -0,0 +1,22 @@ +container: + # official cockpit CI container, with cockpit related build and test dependencies + # if you want to use your own, see the documentation about required packages: + # https://github.com/cockpit-project/cockpit/blob/main/HACKING.md#getting-the-development-dependencies + image: quay.io/cockpit/tasks + kvm: true + # increase this if you have many tests that benefit from parallelism + cpu: 1 + +test_task: + env: + matrix: + - TEST_OS: fedora-37 + - TEST_OS: centos-8-stream + + fix_kvm_script: sudo chmod 666 /dev/kvm + + # test PO template generation + pot_build_script: make po/starter-kit.pot + + # chromium has too little /dev/shm, and we can't make that bigger + check_script: TEST_BROWSER=firefox TEST_JOBS=$(nproc) TEST_OS=$TEST_OS make check diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..85f5a45 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,2 @@ +node_modules/* +pkg/lib/* diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..1918f1a --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,48 @@ +{ + "root": true, + "env": { + "browser": true, + "es6": true + }, + "extends": ["eslint:recommended", "standard", "standard-jsx", "standard-react"], + "parserOptions": { + "ecmaVersion": "2022", + "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 + } +} diff --git a/.fmf/version b/.fmf/version new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/.fmf/version @@ -0,0 +1 @@ +1 diff --git a/.github/workflows/cockpit-lib-update.yml b/.github/workflows/cockpit-lib-update.yml new file mode 100644 index 0000000..2f9de38 --- /dev/null +++ b/.github/workflows/cockpit-lib-update.yml @@ -0,0 +1,30 @@ +name: cockpit-lib-update +on: + schedule: + - cron: '0 2 * * 4' + # can be run manually on https://github.com/cockpit-project/starter-kit/actions + workflow_dispatch: +jobs: + cockpit-lib-update: + runs-on: ubuntu-latest + permissions: + pull-requests: write + contents: write + steps: + - name: Set up dependencies + run: | + sudo apt update + sudo apt install -y make + + - name: Set up configuration and secrets + run: | + printf '[user]\n\tname = Cockpit Project\n\temail=cockpituous@gmail.com\n' > ~/.gitconfig + echo '${{ secrets.GITHUB_TOKEN }}' > ~/.config/github-token + + - name: Clone repository + uses: actions/checkout@v3 + + - name: Run cockpit-lib-update + run: | + make bots + bots/cockpit-lib-update diff --git a/.github/workflows/npm-update-pf.yml b/.github/workflows/npm-update-pf.yml new file mode 100644 index 0000000..e07f20f --- /dev/null +++ b/.github/workflows/npm-update-pf.yml @@ -0,0 +1,30 @@ +name: npm-update-pf +on: + schedule: + - cron: '0 2 * * 1' + # can be run manually on https://github.com/cockpit-project/starter-kit/actions + workflow_dispatch: +jobs: + npm-update: + runs-on: ubuntu-latest + permissions: + pull-requests: write + contents: write + steps: + - name: Set up dependencies + run: | + sudo apt update + sudo apt install -y npm make + + - name: Set up configuration and secrets + run: | + printf '[user]\n\tname = Cockpit Project\n\temail=cockpituous@gmail.com\n' > ~/.gitconfig + echo '${{ secrets.GITHUB_TOKEN }}' > ~/.config/github-token + + - name: Clone repository + uses: actions/checkout@v3 + + - name: Run npm-update bot + run: | + make bots + bots/npm-update @patternfly diff --git a/.github/workflows/npm-update.yml b/.github/workflows/npm-update.yml new file mode 100644 index 0000000..4b06dee --- /dev/null +++ b/.github/workflows/npm-update.yml @@ -0,0 +1,30 @@ +name: npm-update +on: + schedule: + - cron: '0 2 * * 2,4,6' + # can be run manually on https://github.com/cockpit-project/starter-kit/actions + workflow_dispatch: +jobs: + npm-update: + runs-on: ubuntu-latest + permissions: + pull-requests: write + contents: write + steps: + - name: Set up dependencies + run: | + sudo apt update + sudo apt install -y npm make + + - name: Set up configuration and secrets + run: | + printf '[user]\n\tname = Cockpit Project\n\temail=cockpituous@gmail.com\n' > ~/.gitconfig + echo '${{ secrets.GITHUB_TOKEN }}' > ~/.config/github-token + + - name: Clone repository + uses: actions/checkout@v3 + + - name: Run npm-update bot + run: | + make bots + bots/npm-update ~@patternfly diff --git a/.github/workflows/release.yml.disabled b/.github/workflows/release.yml.disabled new file mode 100644 index 0000000..5a5d46a --- /dev/null +++ b/.github/workflows/release.yml.disabled @@ -0,0 +1,38 @@ +# Create a GitHub upstream release. Replace "TARNAME" with your project tarball +# name and enable this by dropping the ".disabled" suffix from the file name. +# See README.md. +name: release +on: + push: + tags: + # this is a glob, not a regexp + - '[0-9]*' +jobs: + source: + runs-on: ubuntu-latest + container: + image: ghcr.io/cockpit-project/unit-tests + options: --user root + permissions: + # create GitHub release + contents: write + steps: + - name: Clone repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + # https://github.blog/2022-04-12-git-security-vulnerability-announced/ + - name: Pacify git's permission check + run: git config --global --add safe.directory /__w/ + + - name: Workaround for https://github.com/actions/checkout/pull/697 + run: git fetch --force origin $(git describe --tags):refs/tags/$(git describe --tags) + + - name: Build release + run: make dist + + - name: Publish GitHub release + uses: cockpit-project/action-release@88d994da62d1451c7073e26748c18413fcdf46e9 + with: + filename: "TARNAME-${{ github.ref_name }}.tar.xz" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..aa13142 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +*~ +*.retry +*.tar.xz +*.rpm +node_modules/ +dist/ +/*.spec +/.vagrant +package-lock.json +Test*FAIL* +/bots +test/common/ +test/images/ +pkg +*.pot +POTFILES* +tmp/ +/po/LINGUAS +/tools diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000..c70e631 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,33 @@ +image: + file: /.gitpod/Dockerfile + +tasks: + - name: dotfiles + command: | + if [ ! -d "~/.dotfiles" ]; then + cd /tmp + curl -sSL https://raw.githubusercontent.com/gbraad/dotfiles/master/install.sh -o /tmp/install.sh && + rm -f ~/.zshrc && + sh /tmp/install.sh + fi + mv ~/.bashrc-nochsh ~/.bashrc + - name: sshd + command: | + sudo ssh-keygen -A && sudo /usr/sbin/sshd + curl https://github.com/gbraad.keys | tee -a ~/.ssh/authorized_keys + - name: tailscale + command: | + sudo --preserve-env=TAILSCALE_AUTHKEY /etc/init.d/tailscaled start + +ports: + - port: 22 + onOpen: ignore + - port: 6080 + onOpen: open-preview + - port: 9090 + onOpen: open-preview + +vscode: + extensions: + - ms-vscode.Theme-TomorrowKit + - tailscale.vscode-tailscale \ No newline at end of file diff --git a/.gitpod/Dockerfile b/.gitpod/Dockerfile new file mode 100644 index 0000000..20783c2 --- /dev/null +++ b/.gitpod/Dockerfile @@ -0,0 +1,13 @@ +FROM --platform=linux/amd64 ghcr.io/gbraad-devenv/fedora/base:38 + +USER root + +# Add gitpod user with the expected ID (automated setup does not work atm) +RUN useradd -l -u 33333 -G wheel -md /home/gitpod -s /usr/bin/zsh -p gitpod gitpod + +RUN dnf install -y \ + docker cockpit \ + && dnf clean all \ + && rm -rf /var/cache/yum + +USER gitpod diff --git a/.stylelintrc.json b/.stylelintrc.json new file mode 100644 index 0000000..352fbe6 --- /dev/null +++ b/.stylelintrc.json @@ -0,0 +1,38 @@ +{ + "extends": "stylelint-config-standard-scss", + "rules": { + "declaration-colon-newline-after": null, + "selector-list-comma-newline-after": null, + + "at-rule-empty-line-before": null, + "declaration-colon-space-before": null, + "declaration-empty-line-before": null, + "custom-property-empty-line-before": null, + "comment-empty-line-before": null, + "scss/double-slash-comment-empty-line-before": null, + "scss/dollar-variable-colon-space-after": null, + + "custom-property-pattern": null, + "declaration-block-no-duplicate-properties": null, + "declaration-block-no-redundant-longhand-properties": null, + "declaration-block-no-shorthand-property-overrides": null, + "declaration-block-single-line-max-declarations": null, + "font-family-no-duplicate-names": null, + "function-url-quotes": null, + "indentation": null, + "keyframes-name-pattern": null, + "max-line-length": null, + "no-descending-specificity": null, + "no-duplicate-selectors": null, + "scss/at-extend-no-missing-placeholder": null, + "scss/at-import-partial-extension": null, + "scss/at-mixin-pattern": null, + "scss/comment-no-empty": null, + "scss/dollar-variable-pattern": null, + "scss/double-slash-comment-whitespace-inside": null, + "scss/no-global-function-names": null, + "scss/operator-no-unspaced": null, + "selector-class-pattern": null, + "selector-id-pattern": null + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/LICENSE @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..1c84d97 --- /dev/null +++ b/Makefile @@ -0,0 +1,203 @@ +# 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 +PREFIX ?= /usr/local +APPSTREAMFILE=org.cockpit-project.$(PACKAGE_NAME).metainfo.xml +VM_IMAGE=$(CURDIR)/test/images/$(TEST_OS) +# stamp file to check for node_modules/ +NODE_MODULES_TEST=package-lock.json +# one example file in dist/ from bundler to check if that already ran +DIST_TEST=dist/manifest.json +# one example file in pkg/lib to check if it was already checked out +COCKPIT_REPO_STAMP=pkg/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: $(DIST_TEST) + +# checkout common files from Cockpit repository required to build this project; +# 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 +COCKPIT_REPO_FILES = \ + pkg/lib \ + test/common \ + $(NULL) + +COCKPIT_REPO_URL = https://github.com/cockpit-project/cockpit.git +COCKPIT_REPO_COMMIT = 536834c40ad3e2390a52fb87583f07302e2a29a4 # 294 + 14 commits + +$(COCKPIT_REPO_FILES): $(COCKPIT_REPO_STAMP) +COCKPIT_REPO_TREE = '$(strip $(COCKPIT_REPO_COMMIT))^{tree}' +$(COCKPIT_REPO_STAMP): Makefile + @git rev-list --quiet --objects $(COCKPIT_REPO_TREE) -- 2>/dev/null || \ + git fetch --no-tags --no-write-fetch-head --depth=1 $(COCKPIT_REPO_URL) $(COCKPIT_REPO_COMMIT) + git archive $(COCKPIT_REPO_TREE) -- $(COCKPIT_REPO_FILES) | tar x + +# +# 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') + +po/$(PACKAGE_NAME).html.pot: $(NODE_MODULES_TEST) $(COCKPIT_REPO_STAMP) + pkg/lib/html2po.js -o $@ $$(find src -name '*.html') + +po/$(PACKAGE_NAME).manifest.pot: $(NODE_MODULES_TEST) $(COCKPIT_REPO_STAMP) + pkg/lib/manifest2po.js 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' > $@ + +# +# Build/Install/dist +# + +$(SPEC): packaging/$(SPEC).in $(NODE_MODULES_TEST) + provides=$$(npm ls --omit dev --package-lock-only --depth=Infinity | grep -Eo '[^[:space:]]+@[^[:space:]]+' | sort -u | sed 's/^/Provides: bundled(npm(/; s/\(.*\)@/\1)) = /'); \ + awk -v p="$$provides" '{gsub(/%{VERSION}/, "$(VERSION)"); gsub(/%{NPM_PROVIDES}/, p)}1' $< > $@ + +$(DIST_TEST): $(NODE_MODULES_TEST) $(COCKPIT_REPO_STAMP) $(shell find src/ -type f) package.json build.js + NODE_ENV=$(NODE_ENV) ./build.js + +watch: $(NODE_MODULES_TEST) $(COCKPIT_REPO_STAMP) + NODE_ENV=$(NODE_ENV) npm run watch + +clean: + rm -rf dist/ + rm -f $(SPEC) + rm -f po/LINGUAS + +install: $(DIST_TEST) po/LINGUAS + mkdir -p $(DESTDIR)$(PREFIX)/share/cockpit/$(PACKAGE_NAME) + cp -r dist/* $(DESTDIR)$(PREFIX)/share/cockpit/$(PACKAGE_NAME) + mkdir -p $(DESTDIR)$(PREFIX)/share/metainfo/ + msgfmt --xml -d po \ + --template $(APPSTREAMFILE) \ + -o $(DESTDIR)$(PREFIX)/share/metainfo/$(APPSTREAMFILE) + +# this requires a built source tree and avoids having to install anything system-wide +devel-install: $(DIST_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 bundler 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 package-lock.json (so that +# node_modules/ can be reconstructed if necessary) +$(TARFILE): export NODE_ENV=production +$(TARFILE): $(DIST_TEST) $(SPEC) + if type appstream-util >/dev/null 2>&1; then appstream-util validate-relax --nonet *.metainfo.xml; fi + tar --xz $(TAR_ARGS) -cf $(TARFILE) --transform 's,^,$(RPM_NAME)/,' \ + --exclude packaging/$(SPEC).in --exclude node_modules \ + $$(git ls-files) $(COCKPIT_REPO_FILES) $(NODE_MODULES_TEST) $(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" + +ifeq ("$(TEST_SCENARIO)","pybridge") +COCKPIT_PYBRIDGE_REF = main +COCKPIT_WHEEL = cockpit-0-py3-none-any.whl + +$(COCKPIT_WHEEL): + pip wheel git+https://github.com/cockpit-project/cockpit.git@${COCKPIT_PYBRIDGE_REF} + +VM_DEPENDS = $(COCKPIT_WHEEL) +VM_CUSTOMIZE_FLAGS = --install $(COCKPIT_WHEEL) +endif + +# 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 $(VM_DEPENDS) + bots/image-customize --no-network --fresh \ + $(VM_CUSTOMIZE_FLAGS) \ + --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 ${RUN_TESTS_OPTIONS} + +# checkout Cockpit's bots for standard test VM images and API to launch them +bots: $(COCKPIT_REPO_STAMP) + test/common/make-bots + +$(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 --ignore-scripts + env -u NODE_ENV npm prune + +.PHONY: all clean install devel-install devel-uninstall print-version dist node-cache rpm prepare-check check vm print-vm diff --git a/README.md b/README.md index 8534884..c7fe95d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ -# tailscale-cockpit Cockpit application to manage Tailscale +======================================= + +**WIP** diff --git a/build.js b/build.js new file mode 100755 index 0000000..6b62d01 --- /dev/null +++ b/build.js @@ -0,0 +1,136 @@ +#!/usr/bin/env node + +import fs from 'node:fs'; +import path from 'node:path'; +import os from 'node:os'; + +import copy from 'esbuild-plugin-copy'; + +import { cleanPlugin } from './pkg/lib/esbuild-cleanup-plugin.js'; +import { cockpitCompressPlugin } from './pkg/lib/esbuild-compress-plugin.js'; +import { cockpitPoEsbuildPlugin } from './pkg/lib/cockpit-po-plugin.js'; +import { cockpitRsyncEsbuildPlugin } from './pkg/lib/cockpit-rsync-plugin.js'; +import { esbuildStylesPlugins } from './pkg/lib/esbuild-common.js'; +import { eslintPlugin } from './pkg/lib/esbuild-eslint-plugin.js'; +import { stylelintPlugin } from './pkg/lib/esbuild-stylelint-plugin.js'; + +const useWasm = os.arch() !== 'x64'; +const esbuild = (await import(useWasm ? 'esbuild-wasm' : 'esbuild')).default; + +const production = process.env.NODE_ENV === 'production'; +const watchMode = process.env.ESBUILD_WATCH === "true"; +// linters dominate the build time, so disable them for production builds by default, but enable in watch mode +const lint = process.env.LINT ? (process.env.LINT !== 0) : (watchMode || !production); +// List of directories to use when using import statements +const nodePaths = ['pkg/lib']; +const outdir = 'dist'; + +// Obtain package name from package.json +const packageJson = JSON.parse(fs.readFileSync('package.json')); + +function notifyEndPlugin() { + return { + name: 'notify-end', + setup(build) { + let startTime; + + build.onStart(() => { + startTime = new Date(); + }); + + build.onEnd(() => { + const endTime = new Date(); + const timeStamp = endTime.toTimeString().split(' ')[0]; + console.log(`${timeStamp}: Build finished in ${endTime - startTime} ms`); + }); + } + }; +} + +const cwd = process.cwd(); + +// similar to fs.watch(), but recursively watches all subdirectories +function watch_dirs(dir, on_change) { + const callback = (ev, dir, fname) => { + // only listen for "change" events, as renames are noisy + // ignore hidden files + const isHidden = /^\./.test(fname); + if (ev !== "change" || isHidden) { + return; + } + on_change(path.join(dir, fname)); + }; + + fs.watch(dir, {}, (ev, path) => callback(ev, dir, path)); + + // watch all subdirectories in dir + const d = fs.opendirSync(dir); + let dirent; + + while ((dirent = d.readSync()) !== null) { + if (dirent.isDirectory()) + watch_dirs(path.join(dir, dirent.name), on_change); + } + d.closeSync(); +} + +const context = await esbuild.context({ + ...!production ? { sourcemap: "linked" } : {}, + bundle: true, + entryPoints: ['./src/index.js'], + external: ['*.woff', '*.woff2', '*.jpg', '*.svg', '../../assets*'], // Allow external font files which live in ../../static/fonts + legalComments: 'external', // Move all legal comments to a .LEGAL.txt file + loader: { ".js": "jsx" }, + minify: production, + nodePaths, + outdir, + target: ['es2020'], + plugins: [ + cleanPlugin(), + ...lint + ? [ + stylelintPlugin({ filter: new RegExp(cwd + '\/src\/.*\.(css?|scss?)$') }), + eslintPlugin({ filter: new RegExp(cwd + '\/src\/.*\.(jsx?|js?)$') }) + ] + : [], + // Esbuild will only copy assets that are explicitly imported and used + // in the code. This is a problem for index.html and manifest.json which are not imported + copy({ + assets: [ + { from: ['./src/manifest.json'], to: ['./manifest.json'] }, + { from: ['./src/index.html'], to: ['./index.html'] }, + ] + }), + ...esbuildStylesPlugins, + cockpitPoEsbuildPlugin(), + ...production ? [cockpitCompressPlugin()] : [], + cockpitRsyncEsbuildPlugin({ dest: packageJson.name }), + notifyEndPlugin(), + ] +}); + +try { + await context.rebuild(); +} catch (e) { + if (!watchMode) + process.exit(1); + // ignore errors in watch mode +} + +if (watchMode) { + const on_change = async path => { + console.log("change detected:", path); + await context.cancel(); + + try { + await context.rebuild(); + } catch (e) {} // ignore in watch mode + }; + + watch_dirs('src', on_change); + + // wait forever until Control-C + await new Promise(() => {}); +} + +context.dispose(); diff --git a/org.cockpit-project.starter-kit.metainfo.xml b/org.cockpit-project.starter-kit.metainfo.xml new file mode 100644 index 0000000..8e19746 --- /dev/null +++ b/org.cockpit-project.starter-kit.metainfo.xml @@ -0,0 +1,17 @@ + + + org.cockpit_project.starter_kit + CC0-1.0 + Starter Kit + Scaffolding for a cockpit module + +

+ Scaffolding for a cockpit module. +

+ + org.cockpit_project.cockpit + starter-kit + https://github.com/cockpit-project/starter-kit + https://github.com/cockpit-project/starter-kit/issues + cockpit-devel_AT_lists.fedorahosted.org + diff --git a/package.json b/package.json new file mode 100644 index 0000000..dd26754 --- /dev/null +++ b/package.json @@ -0,0 +1,55 @@ +{ + "name": "starter-kit", + "description": "Scaffolding for a cockpit module", + "type": "module", + "main": "index.js", + "repository": "git@github.com:cockpit/starter-kit.git", + "author": "", + "license": "LGPL-2.1", + "scripts": { + "watch": "ESBUILD_WATCH='true' ./build.js", + "build": "./build.js", + "eslint": "eslint --ext .js --ext .jsx src/", + "eslint:fix": "eslint --fix --ext .js --ext .jsx src/", + "stylelint": "stylelint src/*{.css,scss}", + "stylelint:fix": "stylelint --fix src/*{.css,scss}" + }, + "devDependencies": { + "argparse": "^2.0.1", + "chrome-remote-interface": "^0.32.1", + "esbuild": "^0.17.15", + "esbuild-plugin-copy": "^2.1.1", + "esbuild-plugin-replace": "^1.3.0", + "esbuild-sass-plugin": "^2.8.0", + "esbuild-wasm": "^0.17.16", + "eslint": "^8.13.0", + "eslint-config-standard": "^17.0.0-1", + "eslint-config-standard-jsx": "^11.0.0-1", + "eslint-config-standard-react": "^13.0.0", + "eslint-plugin-flowtype": "^8.0.3", + "eslint-plugin-import": "^2.26.0", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-promise": "^6.0.0", + "eslint-plugin-react": "^7.29.4", + "eslint-plugin-react-hooks": "^4.4.0", + "eslint-plugin-standard": "^5.0.0", + "htmlparser": "^1.7.7", + "jed": "^1.1.1", + "po2json": "^1.0.0-alpha", + "qunit": "^2.9.3", + "sass": "^1.61.0", + "sizzle": "^2.3.3", + "stylelint": "^14.9.1", + "stylelint-config-standard": "^25.0.0", + "stylelint-config-standard-scss": "^5.0.0", + "stylelint-formatter-pretty": "^3.2.0" + }, + "dependencies": { + "@patternfly/patternfly": "5.0.0-alpha.64", + "@patternfly/react-core": "5.0.0-alpha.115", + "@patternfly/react-styles": "5.0.0-alpha.16", + "@patternfly/react-icons": "5.0.0-alpha.19", + "react": "17.0.2", + "react-dom": "17.0.2" + } +} diff --git a/packaging/cockpit-starter-kit.spec.in b/packaging/cockpit-starter-kit.spec.in new file mode 100644 index 0000000..44d6952 --- /dev/null +++ b/packaging/cockpit-starter-kit.spec.in @@ -0,0 +1,55 @@ +Name: cockpit-starter-kit +Version: %{VERSION} +Release: 1%{?dist} +Summary: Cockpit Starter Kit Example Module +License: LGPLv2+ + +Source0: https://github.com/cockpit-project/starter-kit/releases/download/%{version}/%{name}-%{version}.tar.xz +Source1: https://github.com/cockpit-project/starter-kit/releases/download/%{version}/%{name}-node-%{version}.tar.xz +BuildArch: noarch +ExclusiveArch: %{nodejs_arches} noarch +BuildRequires: nodejs +BuildRequires: make +BuildRequires: libappstream-glib +BuildRequires: gettext +%if 0%{?rhel} && 0%{?rhel} <= 8 +BuildRequires: libappstream-glib-devel +%endif + +Requires: cockpit-bridge + +%{NPM_PROVIDES} + +%description +Cockpit Starter Kit Example Module + +%prep +%autosetup -n %{name} -a 1 +# ignore pre-built bundle in release tarball and rebuild it +# but keep it in RHEL/CentOS-8, as that has a too old nodejs +%if ! 0%{?rhel} || 0%{?rhel} >= 9 +rm -rf dist +%endif + +%build +ESLINT=0 NODE_ENV=production make + +%install +%make_install PREFIX=/usr + +# drop source maps, they are large and just for debugging +find %{buildroot}%{_datadir}/cockpit/ -name '*.map' | xargs --no-run-if-empty rm --verbose + +%check +appstream-util validate-relax --nonet %{buildroot}/%{_datadir}/metainfo/* + +# this can't be meaningfully tested during package build; tests happen through +# FMF (see plans/all.fmf) during package gating + +%files +%doc README.md +%license LICENSE dist/index.js.LEGAL.txt dist/index.css.LEGAL.txt +%{_datadir}/cockpit/* +%{_datadir}/metainfo/* + +%changelog diff --git a/packit.yaml b/packit.yaml new file mode 100644 index 0000000..6258a2e --- /dev/null +++ b/packit.yaml @@ -0,0 +1,67 @@ +# Enable RPM builds and running integration tests in PRs through https://packit.dev/ +# To use this, enable Packit-as-a-service in GitHub: https://packit.dev/docs/packit-as-a-service/ +# See https://packit.dev/docs/configuration/ for the format of this file + +specfile_path: cockpit-starter-kit.spec +# use the nicely formatted release description from our upstream release, instead of git shortlog +copy_upstream_release_description: true + +srpm_build_deps: + - make + - nodejs-npm + +actions: + post-upstream-clone: + - make cockpit-starter-kit.spec + # replace Source1 manually, as create-archive: can't handle multiple tarballs + - make node-cache + - sh -c 'sed -i "/^Source1:/ s/https:.*/$(ls *-node*.tar.xz)/" cockpit-*.spec' + create-archive: make dist + # starter-kit.git has no release tags; your project can drop this once you have a release + get-current-version: make print-version + +jobs: + - job: copr_build + trigger: pull_request + targets: + - fedora-all + - fedora-latest-aarch64 + - centos-stream-8 + - centos-stream-9 + - centos-stream-9-aarch64 + + - job: tests + trigger: pull_request + targets: + - fedora-all + - fedora-latest-aarch64 + - centos-stream-8 + - centos-stream-9 + - centos-stream-9-aarch64 + + # Build releases in COPR: https://packit.dev/docs/configuration/#copr_build + #- job: copr_build + # trigger: release + # owner: your_copr_login + # project: your_copr_project + # preserve_project: True + # targets: + # - fedora-all + # - centos-stream-9-x86_64 + + # Build releases in Fedora: https://packit.dev/docs/configuration/#propose_downstream + #- job: propose_downstream + # trigger: release + # dist_git_branches: + # - fedora-all + + #- job: koji_build + # trigger: commit + # dist_git_branches: + # - fedora-all + + #- job: bodhi_update + # trigger: commit + # dist_git_branches: + # # rawhide updates are created automatically + # - fedora-branched diff --git a/plans/all.fmf b/plans/all.fmf new file mode 100644 index 0000000..2bce34a --- /dev/null +++ b/plans/all.fmf @@ -0,0 +1,6 @@ +summary: + Run all tests +discover: + how: fmf +execute: + how: tmt diff --git a/po/de.po b/po/de.po new file mode 100644 index 0000000..0394e91 --- /dev/null +++ b/po/de.po @@ -0,0 +1,39 @@ +# starter-kit German translations +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: starter-kit 1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2022-03-09 16:09+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=n != 1\n" + +#: src/index.html:20 +msgid "Cockpit Starter Kit" +msgstr "Cockpit Bausatz" + +#: src/app.jsx:43 +msgid "Running on $0" +msgstr "Läuft auf $0" + +#: org.cockpit-project.starter-kit.metainfo.xml:6 +msgid "Scaffolding for a cockpit module" +msgstr "Gerüst für ein Cockpit-Modul" + +#: org.cockpit-project.starter-kit.metainfo.xml:8 +msgid "Scaffolding for a cockpit module." +msgstr "Gerüst für ein Cockpit-Modul." + +#: src/manifest.json:0 org.cockpit-project.starter-kit.metainfo.xml:5 +msgid "Starter Kit" +msgstr "Bausatz" + +#: src/app.jsx:29 +msgid "Unknown" +msgstr "Unbekannt" diff --git a/src/app.jsx b/src/app.jsx new file mode 100644 index 0000000..6d2e4e2 --- /dev/null +++ b/src/app.jsx @@ -0,0 +1,50 @@ +/* + * This file is part of Cockpit. + * + * Copyright (C) 2017 Red Hat, Inc. + * + * Cockpit is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or + * (at your option) any later version. + * + * Cockpit is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Cockpit; If not, see . + */ + +import cockpit from 'cockpit'; +import React from 'react'; +import { Alert } from "@patternfly/react-core/dist/esm/components/Alert/index.js"; +import { Card, CardBody, CardTitle } from "@patternfly/react-core/dist/esm/components/Card/index.js"; + +const _ = cockpit.gettext; + +export class Application extends React.Component { + constructor() { + super(); + this.state = { hostname: _("Unknown") }; + + cockpit.file('/etc/hostname').watch(content => { + this.setState({ hostname: content.trim() }); + }); + } + + render() { + return ( + + Starter Kit + + + + + ); + } +} diff --git a/src/app.scss b/src/app.scss new file mode 100644 index 0000000..6d2c5d8 --- /dev/null +++ b/src/app.scss @@ -0,0 +1,5 @@ +@use "page.scss"; + +p { + font-weight: bold; +} diff --git a/src/index.html b/src/index.html new file mode 100644 index 0000000..2b06bb4 --- /dev/null +++ b/src/index.html @@ -0,0 +1,34 @@ + + + + + Cockpit Starter Kit + + + + + + + + + + + +
+ + diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..3cb37d9 --- /dev/null +++ b/src/index.js @@ -0,0 +1,30 @@ +/* + * This file is part of Cockpit. + * + * Copyright (C) 2017 Red Hat, Inc. + * + * Cockpit is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or + * (at your option) any later version. + * + * Cockpit is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with Cockpit; If not, see . + */ + +import "cockpit-dark-theme"; +import "patternfly/patternfly-5-cockpit.scss"; + +import React from 'react'; +import ReactDOM from 'react-dom'; +import { Application } from './app.jsx'; +import './app.scss'; + +document.addEventListener("DOMContentLoaded", function () { + ReactDOM.render(React.createElement(Application, {}), document.getElementById('app')); +}); diff --git a/src/manifest.json b/src/manifest.json new file mode 100644 index 0000000..3a45f56 --- /dev/null +++ b/src/manifest.json @@ -0,0 +1,11 @@ +{ + "requires": { + "cockpit": "137" + }, + + "tools": { + "index": { + "label": "Starter Kit" + } + } +} diff --git a/test/browser/browser.sh b/test/browser/browser.sh new file mode 100755 index 0000000..d5f594e --- /dev/null +++ b/test/browser/browser.sh @@ -0,0 +1,53 @@ +#!/bin/sh +set -eux + +TESTS="$(realpath $(dirname "$0"))" +SOURCE="$(realpath $TESTS/../..)" +LOGS="$(pwd)/logs" +mkdir -p "$LOGS" +chmod a+w "$LOGS" + +# HACK: https://bugzilla.redhat.com/show_bug.cgi?id=2033020 +dnf update -y pam || true + +# install firefox (available everywhere in Fedora and RHEL) +# we don't need the H.264 codec, and it is sometimes not available (rhbz#2005760) +dnf install --disablerepo=fedora-cisco-openh264 -y --setopt=install_weak_deps=False firefox + +# nodejs 10 is too old for current Cockpit test API +if grep -q platform:el8 /etc/os-release; then + dnf module switch-to -y nodejs:16 +fi + +# create user account for logging in +if ! id admin 2>/dev/null; then + useradd -c Administrator -G wheel admin + echo admin:foobar | chpasswd +fi + +# set root's password +echo root:foobar | chpasswd + +# avoid sudo lecture during tests +su -c 'echo foobar | sudo --stdin whoami' - admin + +# create user account for running the test +if ! id runtest 2>/dev/null; then + useradd -c 'Test runner' runtest + # allow test to set up things on the machine + mkdir -p /root/.ssh + curl https://raw.githubusercontent.com/cockpit-project/bots/main/machine/identity.pub >> /root/.ssh/authorized_keys + chmod 600 /root/.ssh/authorized_keys +fi +chown -R runtest "$SOURCE" + +# disable core dumps, we rather investigate them upstream where test VMs are accessible +echo core > /proc/sys/kernel/core_pattern + +systemctl enable --now cockpit.socket + +# Run tests as unprivileged user +su - -c "env TEST_BROWSER=firefox SOURCE=$SOURCE LOGS=$LOGS $TESTS/run-test.sh" runtest + +RC=$(cat $LOGS/exitcode) +exit ${RC:-1} diff --git a/test/browser/main.fmf b/test/browser/main.fmf new file mode 100644 index 0000000..d2dddd6 --- /dev/null +++ b/test/browser/main.fmf @@ -0,0 +1,15 @@ +summary: + Run browser integration tests on the host +require: + - cockpit-starter-kit + - cockpit-ws + - cockpit-system + - bzip2 + - git-core + - glibc-langpack-de + - libvirt-python3 + - make + - npm + - python3 +test: ./browser.sh +duration: 60m diff --git a/test/browser/run-test.sh b/test/browser/run-test.sh new file mode 100755 index 0000000..99b8029 --- /dev/null +++ b/test/browser/run-test.sh @@ -0,0 +1,39 @@ +#!/bin/sh +set -eux + +# tests need cockpit's bots/ libraries and test infrastructure +cd $SOURCE +git init +rm -f bots # common local case: existing bots symlink +make bots test/common + +# support running from clean git tree +if [ ! -d node_modules/chrome-remote-interface ]; then + # copy package.json temporarily otherwise npm might try to install the dependencies from it + rm -f package-lock.json # otherwise the command below installs *everything*, argh + mv package.json .package.json + # only install a subset to save time/space + npm install chrome-remote-interface sizzle + mv .package.json package.json +fi + +# disable detection of affected tests; testing takes too long as there is no parallelization +mv .git dot-git + +. /etc/os-release +export TEST_OS="${ID}-${VERSION_ID/./-}" +export TEST_AUDIT_NO_SELINUX=1 + +if [ "${TEST_OS#centos-}" != "$TEST_OS" ]; then + TEST_OS="${TEST_OS}-stream" +fi + +EXCLUDES="" + +RC=0 +test/common/run-tests --nondestructive --machine 127.0.0.1:22 --browser 127.0.0.1:9090 $EXCLUDES || RC=$? + +echo $RC > "$LOGS/exitcode" +cp --verbose Test* "$LOGS" || true +# deliver test result via exitcode file +exit 0 diff --git a/test/check-application b/test/check-application new file mode 100755 index 0000000..3d583ea --- /dev/null +++ b/test/check-application @@ -0,0 +1,51 @@ +#!/usr/bin/python3 -cimport os, sys; os.execv(os.path.dirname(sys.argv[1]) + "/common/pywrap", sys.argv) + +# Run this with --help to see available options for tracing and debugging +# See https://github.com/cockpit-project/cockpit/blob/main/test/common/testlib.py +# "class Browser" and "class MachineCase" for the available API. + +import testlib + +# Nondestructive tests all run in the same running VM. This allows them to run in Packit, Fedora, and RHEL dist-git gating +# They must not permanently change any file or configuration on the system in a way that influences other tests. +@testlib.nondestructive +class TestApplication(testlib.MachineCase): + def testBasic(self): + b = self.browser + m = self.machine + + self.login_and_go("/starter-kit") + # verify expected heading + b.wait_text(".pf-v5-c-card__title", "Starter Kit") + + # verify expected host name + hostname = m.execute("cat /etc/hostname").strip() + b.wait_in_text(".pf-v5-c-alert__title", "Running on " + hostname) + + # change current hostname + self.write_file("/etc/hostname", "new-" + hostname) + # verify new hostname name + b.wait_in_text(".pf-v5-c-alert__title", "Running on new-" + hostname) + + # change language to German + b.switch_to_top() + # the menu and dialog changed several times + b.click("#toggle-menu") + b.click(".display-language-menu") + b.wait_popup('display-language-modal') + b.click("#display-language-modal [data-value='de-de'] button") + b.click("#display-language-modal button.pf-m-primary") + b.wait_visible("#content") + # menu label (from manifest) should be translated + b.wait_text("#host-apps a[href='/starter-kit']", "Bausatz") + # window title should be translated; this is not considered as "visible" + self.assertIn("Bausatz", b.call_js_func("ph_text", "head title")) + + b.go("/starter-kit") + b.enter_page("/starter-kit") + # page label (from js) should be translated + b.wait_in_text(".pf-v5-c-alert__title", "Läuft auf") + + +if __name__ == '__main__': + testlib.test_main() diff --git a/test/reference-image b/test/reference-image new file mode 100644 index 0000000..c06d46d --- /dev/null +++ b/test/reference-image @@ -0,0 +1 @@ +fedora-35 diff --git a/test/run b/test/run new file mode 100755 index 0000000..32a21df --- /dev/null +++ b/test/run @@ -0,0 +1,14 @@ +#! /bin/sh +set -eu + +# This is the expected entry point for Cockpit CI; will be called without +# arguments but with an appropriate $TEST_OS, and optionally $TEST_SCENARIO + +TEST_SCENARIO="${TEST_SCENARIO:-}" +[ "${TEST_SCENARIO}" = "${TEST_SCENARIO##firefox}" ] || export TEST_BROWSER=firefox +export RUN_TESTS_OPTIONS=--track-naughties + +# linters are off by default for production builds, but we want to run them in CI +export LINT=1 + +make check diff --git a/test/vm.install b/test/vm.install new file mode 100644 index 0000000..7f3d134 --- /dev/null +++ b/test/vm.install @@ -0,0 +1,12 @@ +#!/bin/sh +# image-customize script to prepare a bots VM for testing this application +# The application package will be installed separately +set -eu + +# don't force https:// (self-signed cert) +printf "[WebService]\\nAllowUnencrypted=true\\n" > /etc/cockpit/cockpit.conf + +if type firewall-cmd >/dev/null 2>&1; then + firewall-cmd --add-service=cockpit --permanent +fi +systemctl enable cockpit.socket