From a9b3c380afea9f7761dcfd18f040732b4fc69bdc Mon Sep 17 00:00:00 2001 From: Fiona Ampofo <64271621+Akyiaa@users.noreply.github.com> Date: Tue, 25 Jul 2023 10:47:34 +0100 Subject: [PATCH 1/6] copyright changes applied Signed-off-by: Fiona Ampofo <64271621+Akyiaa@users.noreply.github.com> --- .babelrc.js | 5 +++++ .eslintrc.js | 5 +++++ .github/scripts/prettier-check.sh | 6 ++++++ .github/scripts/war.sh | 6 ++++++ gatsby-browser.js | 5 +++++ gatsby-node.js | 5 +++++ gatsby-ssr.js | 5 +++++ package-lock.json | 12 ++++++------ src/components/announcement/announcement.js | 7 +++++-- .../announcement/announcement.module.scss | 7 +++++-- src/components/announcement/index.js | 7 +++++-- src/components/button/button.js | 7 +++++-- src/components/button/button.module.scss | 7 +++++-- src/components/button/index.js | 7 +++++-- src/components/footer/footer.js | 7 +++++-- src/components/footer/footer.module.scss | 7 +++++-- src/components/footer/index.js | 7 +++++-- src/components/header/header.js | 7 +++++-- src/components/header/header.module.scss | 7 +++++-- src/components/header/index.js | 7 +++++-- src/components/identifier/identifier.js | 7 +++++-- src/components/identifier/identifier.module.scss | 7 +++++-- src/components/identifier/index.js | 7 +++++-- src/components/key-feature/index.js | 7 +++++-- src/components/key-feature/key-feature.js | 7 +++++-- src/components/key-feature/key-feature.module.scss | 7 +++++-- .../layout/_solarized-light-customized.scss | 7 +++++-- src/components/layout/global-layout.scss | 7 +++++-- src/components/layout/index.js | 7 +++++-- src/components/layout/layout.js | 7 +++++-- src/components/layout/layout.module.scss | 7 +++++-- src/components/search/index.ts | 7 +++++-- src/components/search/search-on-non-local.tsx | 7 +++++-- src/components/search/search.module.scss | 7 +++++-- src/components/search/search.scss | 7 +++++-- src/components/search/search.tsx | 7 +++++-- src/components/seo/index.js | 7 +++++-- src/components/seo/seo.tsx | 6 +++++- src/components/sidebar/index.js | 7 +++++-- src/components/sidebar/level-1-item.js | 7 +++++-- src/components/sidebar/level-2-item.js | 7 +++++-- src/components/sidebar/sidebar.js | 7 +++++-- src/components/sidebar/sidebar.module.scss | 7 +++++-- src/components/site-head/head.tsx | 6 +++++- src/components/site-head/index.ts | 6 +++++- src/components/theme/index.js | 7 +++++-- src/components/theme/theme-consumer.js | 7 +++++-- src/components/theme/theme-context.js | 7 +++++-- src/components/theme/theme-provider.js | 7 +++++-- src/data/nav.yaml | 13 +++++++------ .../docs/first-steps/getting-started.md | 10 +++++++++- src/pages/404.js | 5 +++++ src/pages/404.module.scss | 5 +++++ src/pages/index.js | 5 +++++ src/pages/index.module.scss | 5 +++++ src/styles/_box-sizing.scss | 5 +++++ src/styles/_constants.scss | 5 +++++ src/styles/_styles.scss | 5 +++++ src/styles/mixins/_corner-curl.scss | 5 +++++ src/styles/mixins/_encode-color.scss | 5 +++++ src/styles/mixins/_full-width-container.scss | 5 +++++ src/styles/mixins/_highlight-underline.scss | 5 +++++ src/templates/docTemplate.js | 5 +++++ src/templates/docTemplate.module.scss | 6 ++++++ src/utils/digital-data.js | 5 +++++ src/utils/path.js | 6 ++++++ src/utils/section.js | 5 +++++ svgo.config.js | 5 +++++ 68 files changed, 351 insertions(+), 92 deletions(-) diff --git a/.babelrc.js b/.babelrc.js index 93477d0f..6f067f5a 100644 --- a/.babelrc.js +++ b/.babelrc.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ module.exports = { sourceMaps: true, presets: [`babel-preset-gatsby`, `@babel/preset-typescript`], diff --git a/.eslintrc.js b/.eslintrc.js index e229e3bf..beba365c 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ module.exports = { parser: `@babel/eslint-parser`, globals: { diff --git a/.github/scripts/prettier-check.sh b/.github/scripts/prettier-check.sh index 857e2a39..94079c6e 100755 --- a/.github/scripts/prettier-check.sh +++ b/.github/scripts/prettier-check.sh @@ -1,5 +1,11 @@ #!/bin/bash +# +# Copyright contributors to the Galasa project +# +# SPDX-License-Identifier: EPL-2.0 +# + output=$(npm run format:check:ci 2>/dev/null); rc=$? if [ $rc != 0 ]; then diff --git a/.github/scripts/war.sh b/.github/scripts/war.sh index 37a897e3..336f271c 100755 --- a/.github/scripts/war.sh +++ b/.github/scripts/war.sh @@ -1,4 +1,10 @@ #!/bin/bash + +# +# Copyright contributors to the Galasa project +# +# SPDX-License-Identifier: EPL-2.0 +# set -e set -x diff --git a/gatsby-browser.js b/gatsby-browser.js index deab6ceb..0f0082bd 100644 --- a/gatsby-browser.js +++ b/gatsby-browser.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import "prismjs/plugins/line-numbers/prism-line-numbers.css" import "@fontsource/ibm-plex-mono/400.css" diff --git a/gatsby-node.js b/gatsby-node.js index 09270a1b..7d8e315a 100644 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ const path = require("path") exports.createPages = ({ actions, graphql }) => { diff --git a/gatsby-ssr.js b/gatsby-ssr.js index 7a0cc355..e8cfe41a 100644 --- a/gatsby-ssr.js +++ b/gatsby-ssr.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ const React = require("react") const { globalStyle } = require("./src/components/layout/layout.module.scss") diff --git a/package-lock.json b/package-lock.json index 79574507..d15a2f49 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20237,9 +20237,9 @@ "integrity": "sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw==" }, "node_modules/word-wrap": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", - "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.4.tgz", + "integrity": "sha512-2V81OA4ugVo5pRo46hAoD2ivUJx8jXmWXfUkY4KFNw0hEptvN0QfH3K4nHiwzGeKl5rFKedV48QVoqYavy4YpA==", "engines": { "node": ">=0.10.0" } @@ -35216,9 +35216,9 @@ "integrity": "sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw==" }, "word-wrap": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", - "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==" + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.4.tgz", + "integrity": "sha512-2V81OA4ugVo5pRo46hAoD2ivUJx8jXmWXfUkY4KFNw0hEptvN0QfH3K4nHiwzGeKl5rFKedV48QVoqYavy4YpA==" }, "wrap-ansi": { "version": "7.0.0", diff --git a/src/components/announcement/announcement.js b/src/components/announcement/announcement.js index e165af92..b137baae 100644 --- a/src/components/announcement/announcement.js +++ b/src/components/announcement/announcement.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import announcementStyles from "./announcement.module.scss" diff --git a/src/components/announcement/announcement.module.scss b/src/components/announcement/announcement.module.scss index b4f29990..48512693 100644 --- a/src/components/announcement/announcement.module.scss +++ b/src/components/announcement/announcement.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ .announcement { border-left: 10px solid #0067bc; background-color: #0085f3; diff --git a/src/components/announcement/index.js b/src/components/announcement/index.js index fea9b9de..51d96fb8 100644 --- a/src/components/announcement/index.js +++ b/src/components/announcement/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Announcement from "./announcement" export default Announcement diff --git a/src/components/button/button.js b/src/components/button/button.js index 44943604..d26ebe36 100644 --- a/src/components/button/button.js +++ b/src/components/button/button.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { Link } from "gatsby" diff --git a/src/components/button/button.module.scss b/src/components/button/button.module.scss index abe48b9c..6b18682c 100644 --- a/src/components/button/button.module.scss +++ b/src/components/button/button.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; .buttonContainer { diff --git a/src/components/button/index.js b/src/components/button/index.js index 5f8b4e3d..289159be 100644 --- a/src/components/button/index.js +++ b/src/components/button/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Button from "./button" export default Button diff --git a/src/components/footer/footer.js b/src/components/footer/footer.js index f54d3b93..c5ac0e62 100644 --- a/src/components/footer/footer.js +++ b/src/components/footer/footer.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { useStaticQuery, graphql } from "gatsby" diff --git a/src/components/footer/footer.module.scss b/src/components/footer/footer.module.scss index 98c535c0..86718e55 100644 --- a/src/components/footer/footer.module.scss +++ b/src/components/footer/footer.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; $footer-height: 27rem; diff --git a/src/components/footer/index.js b/src/components/footer/index.js index 35194066..b9b21cfb 100644 --- a/src/components/footer/index.js +++ b/src/components/footer/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Footer from "./footer" export default Footer diff --git a/src/components/header/header.js b/src/components/header/header.js index 500bd123..9d006c30 100644 --- a/src/components/header/header.js +++ b/src/components/header/header.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import { Link, useStaticQuery, graphql } from "gatsby" import React, { useState, useRef, useEffect } from "react" import { Location } from "@reach/router" diff --git a/src/components/header/header.module.scss b/src/components/header/header.module.scss index dc1855c1..1698e9e1 100644 --- a/src/components/header/header.module.scss +++ b/src/components/header/header.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; $navLink-margin-top: 40px; diff --git a/src/components/header/index.js b/src/components/header/index.js index b1a2c37b..9482f5dc 100644 --- a/src/components/header/index.js +++ b/src/components/header/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Header from "./header" export default Header diff --git a/src/components/identifier/identifier.js b/src/components/identifier/identifier.js index ecf51f02..1c9e04ad 100644 --- a/src/components/identifier/identifier.js +++ b/src/components/identifier/identifier.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import { useStaticQuery, graphql, Link } from "gatsby" import React from "react" import { identifier, image } from "./identifier.module.scss" diff --git a/src/components/identifier/identifier.module.scss b/src/components/identifier/identifier.module.scss index 0ce8d1ab..bef828d5 100644 --- a/src/components/identifier/identifier.module.scss +++ b/src/components/identifier/identifier.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ .identifier { text-decoration: none; color: currentColor; diff --git a/src/components/identifier/index.js b/src/components/identifier/index.js index acee1bc4..cf627b96 100644 --- a/src/components/identifier/index.js +++ b/src/components/identifier/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Identifier from "./identifier" export default Identifier diff --git a/src/components/key-feature/index.js b/src/components/key-feature/index.js index 68f9119d..7a7dfe85 100644 --- a/src/components/key-feature/index.js +++ b/src/components/key-feature/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import KeyFeature from "./key-feature" export default KeyFeature diff --git a/src/components/key-feature/key-feature.js b/src/components/key-feature/key-feature.js index a83e3858..c8f6f47d 100644 --- a/src/components/key-feature/key-feature.js +++ b/src/components/key-feature/key-feature.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { diff --git a/src/components/key-feature/key-feature.module.scss b/src/components/key-feature/key-feature.module.scss index 1131ff7b..407f1efc 100644 --- a/src/components/key-feature/key-feature.module.scss +++ b/src/components/key-feature/key-feature.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; .keyFeature { diff --git a/src/components/layout/_solarized-light-customized.scss b/src/components/layout/_solarized-light-customized.scss index cdf23d46..83abc8ca 100644 --- a/src/components/layout/_solarized-light-customized.scss +++ b/src/components/layout/_solarized-light-customized.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ /** Adjusted solarized-light */ code[class*="language-"], pre[class*="language-"] { diff --git a/src/components/layout/global-layout.scss b/src/components/layout/global-layout.scss index c5de0f30..893b865f 100644 --- a/src/components/layout/global-layout.scss +++ b/src/components/layout/global-layout.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; @import "solarized-light-customized"; diff --git a/src/components/layout/index.js b/src/components/layout/index.js index a80709ab..1e99e45a 100644 --- a/src/components/layout/index.js +++ b/src/components/layout/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Layout from "./layout" export default Layout diff --git a/src/components/layout/layout.js b/src/components/layout/layout.js index 5a826624..934753d6 100644 --- a/src/components/layout/layout.js +++ b/src/components/layout/layout.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import Header from "../header" diff --git a/src/components/layout/layout.module.scss b/src/components/layout/layout.module.scss index 2e8950cb..46917b22 100644 --- a/src/components/layout/layout.module.scss +++ b/src/components/layout/layout.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; .container { diff --git a/src/components/search/index.ts b/src/components/search/index.ts index 78e73c48..aa364c69 100644 --- a/src/components/search/index.ts +++ b/src/components/search/index.ts @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Search, { SearchHead } from "./search" import SearchOnNonLocal from "./search-on-non-local" diff --git a/src/components/search/search-on-non-local.tsx b/src/components/search/search-on-non-local.tsx index 2fceb772..629d1272 100644 --- a/src/components/search/search-on-non-local.tsx +++ b/src/components/search/search-on-non-local.tsx @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import Search from "./search" diff --git a/src/components/search/search.module.scss b/src/components/search/search.module.scss index 21455117..c057e1e9 100644 --- a/src/components/search/search.module.scss +++ b/src/components/search/search.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; .button { diff --git a/src/components/search/search.scss b/src/components/search/search.scss index 694afd81..19dffdb3 100644 --- a/src/components/search/search.scss +++ b/src/components/search/search.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/constants"; .DocSearch-Modal { diff --git a/src/components/search/search.tsx b/src/components/search/search.tsx index 84e3b04a..b10d3b9f 100644 --- a/src/components/search/search.tsx +++ b/src/components/search/search.tsx @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React, { useRef, useState, useCallback, useMemo, forwardRef, useEffect } from "react" import { createPortal } from "react-dom" import { useDocSearchKeyboardEvents } from "@docsearch/react" diff --git a/src/components/seo/index.js b/src/components/seo/index.js index 4c4fcaca..7b5bde47 100644 --- a/src/components/seo/index.js +++ b/src/components/seo/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import SEO from "./seo" export default SEO diff --git a/src/components/seo/seo.tsx b/src/components/seo/seo.tsx index 9a64f9e4..6d7dcf2d 100644 --- a/src/components/seo/seo.tsx +++ b/src/components/seo/seo.tsx @@ -1,4 +1,8 @@ -/* Copyright contributors to the Galasa project */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import { useStaticQuery, graphql } from "gatsby" import PropTypes from "prop-types" import React from "react" diff --git a/src/components/sidebar/index.js b/src/components/sidebar/index.js index def6c2a1..07a1759c 100644 --- a/src/components/sidebar/index.js +++ b/src/components/sidebar/index.js @@ -1,4 +1,7 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import Sidebar from "./sidebar" export default Sidebar diff --git a/src/components/sidebar/level-1-item.js b/src/components/sidebar/level-1-item.js index 5800fbb6..44a071c8 100644 --- a/src/components/sidebar/level-1-item.js +++ b/src/components/sidebar/level-1-item.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { Link } from "gatsby" import { Location } from "@reach/router" diff --git a/src/components/sidebar/level-2-item.js b/src/components/sidebar/level-2-item.js index 21d5deec..242b6937 100644 --- a/src/components/sidebar/level-2-item.js +++ b/src/components/sidebar/level-2-item.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { Link } from "gatsby" import { Location } from "@reach/router" diff --git a/src/components/sidebar/sidebar.js b/src/components/sidebar/sidebar.js index ffdaa410..f76e4e27 100644 --- a/src/components/sidebar/sidebar.js +++ b/src/components/sidebar/sidebar.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React, { useState, useEffect } from "react" import { Location, globalHistory } from "@reach/router" import { useStaticQuery, graphql, Link } from "gatsby" diff --git a/src/components/sidebar/sidebar.module.scss b/src/components/sidebar/sidebar.module.scss index 05be23ec..1e0666eb 100644 --- a/src/components/sidebar/sidebar.module.scss +++ b/src/components/sidebar/sidebar.module.scss @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../../styles/styles"; $navBlockTop: 100px + $topic-path-space; diff --git a/src/components/site-head/head.tsx b/src/components/site-head/head.tsx index 5d47bb3d..d0cc46ec 100644 --- a/src/components/site-head/head.tsx +++ b/src/components/site-head/head.tsx @@ -1,4 +1,8 @@ -/* Copyright contributors to the Galasa project */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import PropTypes from "prop-types" import React from "react" import { SearchHead } from "../search" diff --git a/src/components/site-head/index.ts b/src/components/site-head/index.ts index b178deaa..09aba381 100644 --- a/src/components/site-head/index.ts +++ b/src/components/site-head/index.ts @@ -1,3 +1,7 @@ -/* Copyright contributors to the Galasa project */ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import SiteHead from "./head" export default SiteHead diff --git a/src/components/theme/index.js b/src/components/theme/index.js index dcf0df0d..c62e1605 100644 --- a/src/components/theme/index.js +++ b/src/components/theme/index.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ export { default as ThemeProvider } from "./theme-provider" export { default as ThemeConsumer } from "./theme-consumer" export { default as ThemeContext } from "./theme-context" diff --git a/src/components/theme/theme-consumer.js b/src/components/theme/theme-consumer.js index 116c2e3e..b7ef6316 100644 --- a/src/components/theme/theme-consumer.js +++ b/src/components/theme/theme-consumer.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import ThemeContext from "./theme-context" export default ThemeContext.Consumer diff --git a/src/components/theme/theme-context.js b/src/components/theme/theme-context.js index aa515c04..7acdd7a2 100644 --- a/src/components/theme/theme-context.js +++ b/src/components/theme/theme-context.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" export default React.createContext("readable") diff --git a/src/components/theme/theme-provider.js b/src/components/theme/theme-provider.js index 7fe384ed..4c7b121f 100644 --- a/src/components/theme/theme-provider.js +++ b/src/components/theme/theme-provider.js @@ -1,5 +1,8 @@ -/* Copyright contributors to the Galasa project */ - +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import ThemeContext from "./theme-context" diff --git a/src/data/nav.yaml b/src/data/nav.yaml index 0697ca16..e061cb13 100644 --- a/src/data/nav.yaml +++ b/src/data/nav.yaml @@ -1,6 +1,9 @@ -# -# Copyright contributors to the Galasa project -# +# +# Copyright contributors to the Galasa project +# +# SPDX-License-Identifier: EPL-2.0 +# + - sections: - title: Releases root: /releases/ @@ -135,6 +138,4 @@ root: /community/ items: - title: Get involved - path: /community/ - - + path: /community/ \ No newline at end of file diff --git a/src/markdown-pages/docs/first-steps/getting-started.md b/src/markdown-pages/docs/first-steps/getting-started.md index 4a5e8049..c5512ac7 100644 --- a/src/markdown-pages/docs/first-steps/getting-started.md +++ b/src/markdown-pages/docs/first-steps/getting-started.md @@ -9,6 +9,10 @@ You can install Galasa either from a downloadable zip file (zipped distribution) The zipped distribution allows users who do not have access to Maven Central, Eclipse Marketplace and Docker Hub from their company network to use Galasa. Users without restricted internet access who want to use open-source Galasa, can install the Galasa Eclipse plug-in directly from the external update site. +As IP addresses and ports of test machines are stored within the cps.properties file on a users system, we recommend that hard drive encryption is turned on in the operating system where possible. + +## Compatibilities + The following table shows the current compatibility between Eclipse and Galasa versions: @@ -18,14 +22,18 @@ The following table shows the current compatibility between Eclipse and Galasa v | 2022-09 | 0.27.0 and later | | 2022-06 | 0.26.0, 0.25.0 | +Note: We currently support Java version 11 to version 16 JDK. We do not currently support Java 17 or later. If your Eclipse version comes with Java 17 or later, ensure that the JRE environment refers to a Java 11 runtime in your Eclipse launch configuration. -As IP addresses and ports of test machines are stored within the cps.properties file on a users system, we recommend that hard drive encryption is turned on in the operating system where possible. +You can tell Eclipse about an installed runtime by going to _Settings_>_Java_>_Installed JREs_ from the Eclipse menu, and adding the Java 11 runtime to the list of installed JREs. You can set this runtime as default so that Eclipse launches tests with a Java 11 runtime. + +## Installing To install the Galasa plug-in from the external update site, follow the instructions in [Installing the Galasa plug-in](/docs/getting-started/installing-online). To install the Galasa plug-in using the zipped distribution, follow the instructions in [Installing the Galasa plug-in offline](/docs/getting-started/installing-offline). +## Next steps You can then start [exploring Galasa Simbank](/docs/getting-started/simbank); a component distributed with Galasa that you can start playing with to help you to learn about the Galasa basics. diff --git a/src/pages/404.js b/src/pages/404.js index 769aa7d7..3f344f1b 100644 --- a/src/pages/404.js +++ b/src/pages/404.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { block, heading, subheading, text } from "./404.module.scss" diff --git a/src/pages/404.module.scss b/src/pages/404.module.scss index 738ac18e..008ea0cc 100644 --- a/src/pages/404.module.scss +++ b/src/pages/404.module.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../styles/styles"; .block { diff --git a/src/pages/index.js b/src/pages/index.js index be24a473..3dfae9c1 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { graphql, Link } from "gatsby" diff --git a/src/pages/index.module.scss b/src/pages/index.module.scss index a14fa4d9..123443e8 100644 --- a/src/pages/index.module.scss +++ b/src/pages/index.module.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "../styles/styles"; $br-sm: 600px; diff --git a/src/styles/_box-sizing.scss b/src/styles/_box-sizing.scss index 474a02fa..c400c1a7 100644 --- a/src/styles/_box-sizing.scss +++ b/src/styles/_box-sizing.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ html { box-sizing: border-box; } diff --git a/src/styles/_constants.scss b/src/styles/_constants.scss index 4ce9cead..9e5ed00d 100644 --- a/src/styles/_constants.scss +++ b/src/styles/_constants.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ $br-small: 902px; $br-single-column: 932px; diff --git a/src/styles/_styles.scss b/src/styles/_styles.scss index df6e395c..f0ce190d 100644 --- a/src/styles/_styles.scss +++ b/src/styles/_styles.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @import "box-sizing"; @import "constants"; diff --git a/src/styles/mixins/_corner-curl.scss b/src/styles/mixins/_corner-curl.scss index 648572f8..6473f86d 100644 --- a/src/styles/mixins/_corner-curl.scss +++ b/src/styles/mixins/_corner-curl.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @mixin cornerCurlLeft($color) { &::after { $height: 50px; diff --git a/src/styles/mixins/_encode-color.scss b/src/styles/mixins/_encode-color.scss index dab0ab46..566cc88b 100644 --- a/src/styles/mixins/_encode-color.scss +++ b/src/styles/mixins/_encode-color.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @function encodeColor($string) { @if type-of($string) == "color" and str-index(#{$string}, "#") == 1 { $hex: str-slice(ie-hex-str($string), 4); diff --git a/src/styles/mixins/_full-width-container.scss b/src/styles/mixins/_full-width-container.scss index 61d9115a..b3feb92d 100644 --- a/src/styles/mixins/_full-width-container.scss +++ b/src/styles/mixins/_full-width-container.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @mixin full-width-container { margin-left: (-$margin-container-sm); margin-right: (-$margin-container-sm); diff --git a/src/styles/mixins/_highlight-underline.scss b/src/styles/mixins/_highlight-underline.scss index b3891fbb..80c8bed5 100644 --- a/src/styles/mixins/_highlight-underline.scss +++ b/src/styles/mixins/_highlight-underline.scss @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ @mixin highlight-underline { display: inline; background-image: linear-gradient(0deg, #f8f68f 40%, transparent 40%); diff --git a/src/templates/docTemplate.js b/src/templates/docTemplate.js index 15ed4cbf..7811d51a 100644 --- a/src/templates/docTemplate.js +++ b/src/templates/docTemplate.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ import React from "react" import { graphql } from "gatsby" import { diff --git a/src/templates/docTemplate.module.scss b/src/templates/docTemplate.module.scss index 499170c6..6be30970 100644 --- a/src/templates/docTemplate.module.scss +++ b/src/templates/docTemplate.module.scss @@ -1,3 +1,9 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ + @import "../styles/styles"; .docWrapper { diff --git a/src/utils/digital-data.js b/src/utils/digital-data.js index f71afc14..da104719 100644 --- a/src/utils/digital-data.js +++ b/src/utils/digital-data.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ const digitalDataScript = `window.idaPageIsSPA=true;window.digitalData={page:{category:{primaryCategory:'NO_CATEGORY_ASSIGNED'},pageInfo:{ibm:{siteID:'IBM_NONMARKETING'}}}}` module.exports = digitalDataScript diff --git a/src/utils/path.js b/src/utils/path.js index b9541dd4..7fa87153 100644 --- a/src/utils/path.js +++ b/src/utils/path.js @@ -1,3 +1,9 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ + export const normalisePath = (/** @type {String} */ input) => { while (input.length > 0 && input.charAt(input.length - 1) === "/") { input = input.substr(0, input.length - 1) diff --git a/src/utils/section.js b/src/utils/section.js index 2998ac24..34834509 100644 --- a/src/utils/section.js +++ b/src/utils/section.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ export const isSelectedSection = (section, location) => { return ( location.pathname.startsWith(`/${section}/`) || diff --git a/svgo.config.js b/svgo.config.js index e18a38b6..5a129229 100644 --- a/svgo.config.js +++ b/svgo.config.js @@ -1,3 +1,8 @@ +/* + * Copyright contributors to the Galasa project + * + * SPDX-License-Identifier: EPL-2.0 + */ module.exports = { multipass: true, js2svg: { From 24611edf94c6503c2b86a5d770a03cee0de91de6 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 25 Jul 2023 14:09:41 +0100 Subject: [PATCH 2/6] add portfolio info --- .../cli-command-reference/runs-prepare.md | 75 ++++++++++++++----- .../docs/cli-command-reference/runs-submit.md | 30 ++++---- 2 files changed, 74 insertions(+), 31 deletions(-) diff --git a/src/markdown-pages/docs/cli-command-reference/runs-prepare.md b/src/markdown-pages/docs/cli-command-reference/runs-prepare.md index ecc20fcf..e39af114 100644 --- a/src/markdown-pages/docs/cli-command-reference/runs-prepare.md +++ b/src/markdown-pages/docs/cli-command-reference/runs-prepare.md @@ -3,7 +3,9 @@ path: "/docs/cli-command-reference/ecosystem-cli-runs-prepare" title: "Selecting tests to run in the Ecosystem" --- -The `runs prepare` command builds a portfolio of tests which can then be run by using the `runs submit` command. You can build a portfolio of tests from single or multiple [test streams](https://galasa.dev/docs/writing-own-tests/test-streams). +If you have a group of tests that you want to run in batch, the simplest way to do this is by defining these tests inside a portfolio. You can create a portfolio of tests by using the `runs prepare` command. You can build the portfolio from single or multiple [test streams](https://galasa.dev/docs/writing-own-tests/test-streams). + +This portfolio of tests can then be run by using the [runs submit command](/docs/cli-command-reference/ecosystem-cli-runs-submit). When you submit the tests to run, you need specify only the portfolio name on the command, rather than listing all of the classes. ## Working with the `runs prepare` command @@ -12,13 +14,14 @@ The following section provides a subset of examples that use the `runs prepare` ### Selecting tests from a test steam -The following example command selects tests from a test stream called `BestSoFar` for inclusion in a portfolio called `test.yaml`. All tests in the `dev.galasa.simbank.tests` package within the `BestSoFar` test stream are added to the `test.yaml` portfolio. Packages are selected if the name contains a specified string or matches the regex if --regex is specified. +The following example command selects tests from a test stream called `BestSoFar` for inclusion in a portfolio called `my_portfolio.yaml`. All tests in the `dev.galasa.simbank.tests` package within the `BestSoFar` test stream are added to the `my_portfolio.yaml` portfolio. Packages are selected if the name contains a specified string or matches the regex if --regex is specified. On Mac or Unix: ``` galasactl runs prepare \ - --portfolio test.yaml \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ --stream BestSoFar \ --package dev.galasa.simbank.tests ``` @@ -27,22 +30,50 @@ On Windows (Powershell): ``` galasactl runs prepare ` - --portfolio test.yaml ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` --stream BestSoFar ` --package dev.galasa.simbank.tests ``` +### Building a portfolio for multiple test packages + +You can build a portfolio for multiple test package by using a comma separated list. + +The following example command selects tests from the `dev.galasa.simbank.tests` and `dev.galasa.example.banking` test packages and adds these tests to the `my_portfolio.yaml` portfolio. + +On Mac or Unix: + +``` +galasactl runs prepare \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ + --stream BestSoFar \ + --package dev.galasa.simbank.tests,dev.galasa.example.banking +``` + +On Windows (Powershell): + +``` +galasactl runs prepare ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` + --stream BestSoFar ` + --package dev.galasa.simbank.tests,dev.galasa.example.banking +``` + ### Selecting tests without a test stream You can use test class names to build a portfolio when a test stream or test catalog is not available. -The following example command selects specified tests (`SimBankIVT` and `BasicAccountCreditTest`) from the `dev.galasa.simbank.tests` test package and adds these tests to the `test.yaml` portfolio. +The following example command selects specified tests (`SimBankIVT` and `BasicAccountCreditTest`) from the `dev.galasa.simbank.tests` test package and adds these tests to the `my_portfolio.yaml` portfolio. On Mac or Unix: ``` galasactl runs prepare \ - --portfolio test.yaml \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ --class dev.galasa.simbank.tests/SimBankIVT \ --class dev.galasa.simbank.tests/BasicAccountCreditTest ``` @@ -51,7 +82,8 @@ On Windows (Powershell): ``` galasactl runs prepare ` - --portfolio test.yaml ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` --class dev.galasa.simbank.tests/SimBankIVT ` --class dev.galasa.simbank.tests/BasicAccountCreditTest ``` @@ -61,15 +93,16 @@ galasactl runs prepare ` Specifying overrides is useful if you want to run a set of tests against a particular configuration without changing the test code. For example, you might have multiple versions of software that you need to test. How can you do that without changing the test code? The answer is to use override properties. If you are running tests locally, you can set overrides properties by editing your `Overrides Properties` file. If you are running tests in an ecosystem, you can use the `--override` parameter in the Galasa CLI. Note that overrides in the portfolio take precedence over the overrides on the `runs submit` command. This is so you can set general overrides on the submit, but have specific class overrides in the portfolio. -The following example creates a portfolio called `test.yaml` that contains tests from the `BestSoFar` test stream where the test package is `dev.galasa.simbank.tests`. +The following example creates a portfolio called `my_portfolio.yaml` that contains tests from the `BestSoFar` test stream where the test package is `dev.galasa.simbank.tests`. -All the tests in the `test.yaml` portfolio will run on the z/OS LPAR `MYLPAR` in the `MYPLEX` cluster when the `galasactl runs submit --portfolio test.yaml` command is run, regardless of the LPAR and cluster that is specified in the CPS properties file. +All the tests in the `my_portfolio.yaml` portfolio will run on the z/OS LPAR `MYLPAR` in the `MYPLEX` cluster when the `galasactl runs submit --portfolio my_portfolio.yaml` command is run, regardless of the LPAR and cluster that is specified in the CPS properties file. On Mac or Unix: ``` galasactl runs prepare \ - --portfolio test.yaml \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ --stream BestSoFar \ --package dev.galasa.simbank.tests \ --override zos.default.lpar=MYLPAR \ @@ -80,7 +113,8 @@ On Windows (Powershell): ``` galasactl runs prepare ` - --portfolio test.yaml ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` --stream BestSoFar ` --package dev.galasa.simbank.tests ` --override zos.default.lpar=MYLPAR ` @@ -92,21 +126,23 @@ galasactl runs prepare ` You can select tests by using "package" OR "bundle" OR "test". If a test is selected multiple times, it will only be added once. Duplicate tests are appended, enabling the same test to be selected multiple times with different overrides. -In the following example, the first command creates a portfolio called `test.yaml` that contains tests from the `BestSoFar` test stream where the test package name is `dev.galasa.simbank.tests`. The second command adds more tests to the `test.yaml` portfolio from the `BestSoFar` test stream where the test package name is `dev.galasa.simbank.tests.two`. +In the following example, the first command creates a portfolio called `my_portfolio.yaml` that contains tests from the `BestSoFar` test stream where the test package name is `dev.galasa.simbank.tests`. The second command adds more tests to the `my_portfolio.yaml` portfolio from the `BestSoFar` test stream where the test package name is `dev.galasa.simbank.tests.two`. -All the tests in the `test.yaml` portfolio from the `dev.galasa.simbank.tests` package will run on the z/OS LPAR `MYLPAR` in the `MYPLEX` cluster. The tests from the `dev.galasa.simbank.tests.two` package will run on the z/OS LPAR `MYLPAR2` in the `MYPLEX` cluster when the `galasactl runs submit --portfolio test.yaml` command is run. +All the tests in the `my_portfolio.yaml` portfolio from the `dev.galasa.simbank.tests` package will run on the z/OS LPAR `MYLPAR` in the `MYPLEX` cluster. The tests from the `dev.galasa.simbank.tests.two` package will run on the z/OS LPAR `MYLPAR2` in the `MYPLEX` cluster when the `galasactl runs submit --portfolio my_portfolio.yaml` command is run. On Mac or Unix: ``` galasactl runs prepare \ - --portfolio test.yaml \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ --stream BestSoFar \ --package dev.galasa.simbank.tests \ --override zos.default.lpar=MYLPAR \ --override zos.default.cluster=MYPLEX \ galasactl runs prepare \ - --portfolio test.yaml \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ --append \ --stream BestSoFar \ --package dev.galasa.simbank.tests.two \ @@ -114,16 +150,19 @@ galasactl runs prepare \ --override zos.default.cluster=MYPLEX ``` -On Windows (Powershell) +On Windows (Powershell): + ``` galasactl runs prepare ` - --portfolio test.yaml ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` --stream BestSoFar ` --package dev.galasa.simbank.tests ` --override zos.default.lpar=MYLPAR ` --override zos.default.cluster=MYPLEX ` galasactl runs prepare ` - --portfolio test.yaml ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` --append ` --stream BestSoFar ` --package dev.galasa.simbank.tests.two ` diff --git a/src/markdown-pages/docs/cli-command-reference/runs-submit.md b/src/markdown-pages/docs/cli-command-reference/runs-submit.md index cd9a405c..5160fe1f 100644 --- a/src/markdown-pages/docs/cli-command-reference/runs-submit.md +++ b/src/markdown-pages/docs/cli-command-reference/runs-submit.md @@ -3,24 +3,24 @@ path: "/docs/cli-command-reference/ecosystem-cli-runs-submit" title: "Running tests in the Ecosystem" --- -The `runs submit` command submits and monitors tests in the Galasa Ecosystem. Tests can be input either from a portfolio or directly from a test package. +The `runs submit` command submits and monitors tests in the Galasa Ecosystem. Tests can be input either from a portfolio or directly from a test package. -For information about creating a portfolio by using the Galasa CLI, see the documentation for the `runs prepare` command. +For information about creating a portfolio by using the Galasa CLI, see the documentation for the [runs prepare](/docs/cli-command-reference/ecosystem-cli-runs-prepare) command. ## Working with the `runs submit` command The following section provides a subset of examples of how you can use the `runs submit` command to complete various tasks, for example, getting help, submitting tests, and setting overrides. The examples build on the Galasa SimBank tests, which you can run non-locally if you have an ecosystem that is running SimPlatform. - ### Submitting tests to an ecosystem from a portfolio -The following example assumes that you have created a `test.yaml` portfolio by using the [runs prepare](./ecosystem-cli-runs-prepare) command. The command submits tests from the `test.yaml` portfolio, and specifies the following settings. +The following example assumes that you have created a `my_portfolio.yaml` portfolio by using the [runs prepare](/docs/cli-command-reference/ecosystem-cli-runs-prepare) command. The command submits tests from the `my_portfolio.yaml` portfolio, and specifies the following settings. On Mac or Unix: ``` galasactl runs submit \ - --portfolio test.yaml \ + --bootstrap http://example.com:30960/boostrap \ + --portfolio my_portfolio.yaml \ --poll 5 \ --progress 1 \ --throttle 5 \ @@ -31,21 +31,23 @@ On Windows (Powershell): ``` galasactl runs submit ` - --portfolio test.yaml ` + --bootstrap http://example.com:30960/boostrap ` + --portfolio my_portfolio.yaml ` --poll 5 ` --progress 1 ` --throttle 5 ` --log - ``` -where: -- `poll` specifies the frequency in seconds that the CLI polls the Ecosystem for test run status. +where: + +- `portfolio` specifies the portfolio that defines the tests that you want to run +- `poll` specifies the frequency in seconds that the CLI polls the Ecosystem for test run status. - `progress` specifies the frequency in minutes that the CLI reports the overall progress of the test runs. A value of `-1` or less disables progress reports. - `throttle` specifies the number of test runs that can be submitted in parallel. A value of `0` or less prevents throttling. - `log` specifies that the progress log should be directed somewhere, and the `-` means that it should be sent to the console (stderr) so it is visible. - ### Submitting tests without a portfolio You can use test class names to submit test runs without using a portfolio. @@ -56,6 +58,7 @@ On Mac or Unix: ``` galasactl runs submit \ + --bootstrap http://example.com:30960/boostrap \ --class dev.galasa.simbank.tests/SimBankIVT \ --class dev.galasa.simbank.tests/BasicAccountCreditTest \ --log - @@ -65,6 +68,7 @@ On Windows (Powershell): ``` galasactl runs submit ` + --bootstrap http://example.com:30960/boostrap ` --class dev.galasa.simbank.tests/SimBankIVT ` --class dev.galasa.simbank.tests/BasicAccountCreditTest ` --log - @@ -73,15 +77,15 @@ galasactl runs submit ` ### Setting overrides for all tests during a run -Specifying overrides is useful if you want to run a set of tests against a particular configuration without changing the test code. For example, you might have multiple versions of software that you need to test. How can you do that without changing the test code? The answer is to use override properties. If you are running tests locally, you can set overrides properties by editing your `Overrides Properties` file. If you are running tests in an ecosystem, you can use the `--override` parameter in the Galasa CLI. Note that overrides in the portfolio take precedence over the overrides on the `runs submit` command. This is so that you can set general overrides on the submit, but have specific class overrides in the portfolio. +Specifying overrides is useful if you want to run a set of tests against a particular configuration without changing the test code. For example, you might have multiple versions of software that you need to test. How can you do that without changing the test code? The answer is to use override properties. If you are running tests locally, you can set overrides properties by editing your `Overrides Properties` file. If you are running tests in an ecosystem, you can use the `--override` parameter in the Galasa CLI. Note that overrides in the portfolio take precedence over the overrides on the `runs submit` command. This is so that you can set general overrides on the submit, but have specific class overrides in the portfolio. -The following command runs all the tests in the `test.yaml` portfolio are on the z/OS LPAR `MYLPAR` in the `MYPLEX` cluster. +The following command runs all the tests in the `my_portfolio.yaml` portfolio are on the z/OS LPAR `MYLPAR` in the `MYPLEX` cluster. On Mac or Unix: ``` galasactl runs submit \ - --portfolio test.yaml \ + --portfolio my_portfolio.yaml \ --override zos.default.lpar=MYLPAR \ --override zos.default.cluster=MYPLEX \ --log - @@ -91,7 +95,7 @@ On Windows (Powershell): ``` galasactl runs submit ` - --portfolio test.yaml ` + --portfolio my_portfolio.yaml ` --override zos.default.lpar=MYLPAR ` --override zos.default.cluster=MYPLEX ` --log - From 495bb4aca00e2302e822445b0548422c3a34a5a4 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 25 Jul 2023 14:31:35 +0100 Subject: [PATCH 3/6] minutes and utc udpates --- .../docs/cli-command-reference/runs-get.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/src/markdown-pages/docs/cli-command-reference/runs-get.md b/src/markdown-pages/docs/cli-command-reference/runs-get.md index e9aa184d..66d2c7a8 100644 --- a/src/markdown-pages/docs/cli-command-reference/runs-get.md +++ b/src/markdown-pages/docs/cli-command-reference/runs-get.md @@ -17,7 +17,7 @@ Use the tables provided to view the options for filtering test results, and for | :---- | :-------- | | `--name` | Use the `--name` option to query the status of a particular test run. | | `--requestor`| Use the `--requestor` option to view results of test runs that were submitted to the ecosystem by a specified user. The default is the current user name that is specified in the access token.| -| `--age`| Use the `--age` option to specify a time period in which the tests ran. The _age_ option is specified in the format _FROM:TO_. Units of time can be specified in weeks _w_, days _d_, or hours _h_. The _FROM_ part is mandatory. The _TO_ part is optional, with a default set to `0`, which indicates the current time. The _FROM_ value specifies how far back in time the query is applied. The _FROM_ value must therefore always be a larger value than the _TO_ value. If the `--name` option is specified, the `--age` parameter is not used. | +| `--age`| Use the `--age` option to specify a time period in which the tests ran. The _age_ option is specified in the format _FROM:TO_. Units of time can be specified in weeks _w_, days _d_, hours _h_, or minutes _m_. The _FROM_ part is mandatory. The _TO_ part is optional, with a default set to `0`, which indicates the current time. The _FROM_ value specifies how far back in time the query is applied. The _FROM_ value must therefore always be a larger value than the _TO_ value. The returned times are in UTC (Coordinated Universal Time). If the `--name` option is specified, the `--age` parameter is not used. | | `--result` | Use the [`--result` option](#result) to return test runs based on test run results. You can select more than one result by using a comma-separated list. | Table 2: The following table shows the options that you can set on the `galasactl runs get` command to display test run results in different formats: @@ -83,7 +83,7 @@ Results are returned on the terminal in the following example format: $galasactl runs get --bootstrap http://example.com:30960/boostrap \ --requestor bobsmith --age 2w:1w --format summary -submitted-time name status result test-name +submitted-time(UTC) name status result test-name 2023-05-04 10:55:29 U456 finished Passed MyTestName1 2023-05-05 10:45:29 U856 finished Passed MyTestName2 2023-05-06 11:55:29 U859 finished Passed MyTestName3 @@ -123,19 +123,19 @@ Results are returned on the terminal in the following example format: ``` $galasactl runs get --name U456 --format details --bootstrap http://example.com:30960/boostrap -name : U456 -status : finished -result : Passed -submitted-time : 2023-05-04 10:55:29 -start-time : 2023-05-05 06:00:14 -end-time : 2023-05-05 06:00:15 -duration(ms) : 1000 -test-name : dev.galasa.Zos3270LocalJava11Ubuntu -requestor : bobsmith -bundle : dev.galasa -run-log : https://127.0.0.1/ras/run/cbd-123/runlog - -method type status result start-time end-time duration(ms) +name : U456 +status : finished +result : Passed +submitted-time(UTC) : 2023-05-04 10:55:29 +start-time(UTC) : 2023-05-05 06:00:14 +end-time(UTC) : 2023-05-05 06:00:15 +duration(ms) : 1000 +test-name : dev.galasa.Zos3270LocalJava11Ubuntu +requestor : bobsmith +bundle : dev.galasa +run-log : https://127.0.0.1/ras/run/cbd-123/runlog + +method type status result start-time(UTC) end-time(UTC) duration(ms) testCoreIvtTest test finished Passed 2023-05-05 06:03:38 2023-05-05 06:03:39 1000 Total:1 Passed:1 @@ -194,7 +194,7 @@ Results are returned on the terminal in the following example format: ``` galasactl runs get --age 1d --result failed,envfail --bootstrap http://example.com:30960/boostrap -submitted-time name status result test-name +submitted-time(UTC) name status result test-name 2023-05-05 10:55:29 U456 ending Failed MyTestName1 2023-05-05 10:55:39 U856 ending Failed MyTestName2 2023-05-05 10:55:49 U859 ending EnvFail MyTestName3 From 5e87c12ebe907f8825d6490dee2600048f812717 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 25 Jul 2023 15:37:39 +0100 Subject: [PATCH 4/6] obr info --- .../docs/writing-own-tests/setting-up-galasa-project.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md b/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md index 036d15b0..55177415 100644 --- a/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md +++ b/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md @@ -100,7 +100,8 @@ where
- ```--package``` is the name of a Java package. This parameter is mandatory. Use the provided example to help you to understand how you might create unique names for your Java test packages. Sections can reflect your company, organisation, the application under test, or any other name-spacing of your choice. The value chosen influences the names of the folders, OSGi bundles, Maven coordinates, and the eventual Java package name in which example tests are created. The name must be all lower-case letters and numbers (`a-z`, `0-9`), with `.` (period) character separators. No part of the name can clash with a Java language reserved word.
- ```--features``` is a comma-separated list of one or more features of the application that you want to test. This parameter is optional, defaulting to `test`. The entries in this list influence the names of some folders, OSGi bundles, Maven coordinates and Java class names of the generated example tests. In the example provided, the banking application under test has a `payee` section and an `account` section which need testing. Creating subcomponents of your test suite to test these features or components of the application creates a naming structure in which your tests can be organised. These names must be lower-case letters and numbers (`a-z`, `0-9`), with no `.` (period) or special characters. No part of the name can clash with a Java language reserved word.
- ```--force``` is an optional flag. If the flag is missing, then any file that the Galasa CLI tool tries to create which already exists causes a failure, and the original file is preserved. If this flag is used, then such files are silently over-written. Use this option carefully to avoid some of your files being over-written, resulting in the loss of some of your data. -- ```--obr``` Creates an OBR project. For tests to run in the ecosystem they require compiled artifacts to be hosted in a Maven repository. The artifacts must be bundled as an OSGI bundle. Creating an OBR project makes it easier to move from running a test locally to running that test in an ecosystem. +- ```--obr``` Creates an OBR project. An OBR (OSGi Bundle Repository) is an index of OSGi bundles. Galasa testcases are built into OSGi bundles which are then connected into an OBR. When you specify the location of the OBR to Galasa, the OBR tells Galasa where the tests are stored. You can create an OBR from scratch, or you can create projects and add them into an existing OBR. For more information about OBRs, see the Apache Felix website. + - ```--log -``` sends the trace and logging output that is generated by the tool to the console. ## Building the example project From 0bb8731acd59d2e721800eae7b5aff52f2dc8fca Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 25 Jul 2023 16:40:16 +0100 Subject: [PATCH 5/6] result flag info --- src/markdown-pages/docs/cli-command-reference/runs-get.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/markdown-pages/docs/cli-command-reference/runs-get.md b/src/markdown-pages/docs/cli-command-reference/runs-get.md index 66d2c7a8..d1cab635 100644 --- a/src/markdown-pages/docs/cli-command-reference/runs-get.md +++ b/src/markdown-pages/docs/cli-command-reference/runs-get.md @@ -18,7 +18,8 @@ Use the tables provided to view the options for filtering test results, and for | `--name` | Use the `--name` option to query the status of a particular test run. | | `--requestor`| Use the `--requestor` option to view results of test runs that were submitted to the ecosystem by a specified user. The default is the current user name that is specified in the access token.| | `--age`| Use the `--age` option to specify a time period in which the tests ran. The _age_ option is specified in the format _FROM:TO_. Units of time can be specified in weeks _w_, days _d_, hours _h_, or minutes _m_. The _FROM_ part is mandatory. The _TO_ part is optional, with a default set to `0`, which indicates the current time. The _FROM_ value specifies how far back in time the query is applied. The _FROM_ value must therefore always be a larger value than the _TO_ value. The returned times are in UTC (Coordinated Universal Time). If the `--name` option is specified, the `--age` parameter is not used. | -| `--result` | Use the [`--result` option](#result) to return test runs based on test run results. You can select more than one result by using a comma-separated list. | +| `--result` | Use the [`--result` option](#result) to return test runs based on test run results. You can select more than one result by using a comma-separated list. The `--result` flag cannot be used in conjunction with the `--active` flag. The two flags are mutually exclusive. | +| `--active` | Use the `--active` option to query tests that have not finished, so that you can quickly see which tests are currently running. The `--active` flag cannot be used in conjunction with the `--result` flag. The two flags are mutually exclusive.| Table 2: The following table shows the options that you can set on the `galasactl runs get` command to display test run results in different formats: From 7c799e98376ebc95c0b72897c92b56cd2d5bfc63 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 25 Jul 2023 16:56:47 +0100 Subject: [PATCH 6/6] force maven or gradle flag --- .../docs/writing-own-tests/setting-up-galasa-project.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md b/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md index 036d15b0..31defae2 100644 --- a/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md +++ b/src/markdown-pages/docs/writing-own-tests/setting-up-galasa-project.md @@ -10,7 +10,7 @@ You can pass parameters to the `galasactl project create` command, enabling you Maven and Gradle are both build tools, which read metadata from files which guide how the code within a module should be built. Maven and Gradle use different formats for these build files. Artifacts are created on disk and can later be built, tested and deployed to a Maven repository and used in the Galasa Ecosystem. Generated artifacts can be embellished and refactored to form the basis of future Galasa tests. -The `galasactl project create` command uses the `--maven` and `--gradle` parameters to allow you to decide which type of build system to use when creating the example project. By default, the `galasactl project create` command generates a project which includes a Maven build mechanism. You can also pass the `--maven` flag explicitly to tell the tool to generate Maven build artifacts (pom.xml files). +The `galasactl project create` command uses the `--maven` and `--gradle` parameters to allow you to decide which type of build system to use when you create a project. You must specify either the `--maven` flag or the `--gradle` flag when you run the `galasactl project create` command. You can specify both flags to tell the tool to generate Maven build artifacts (pom.xml files) and Gradle files. The example provided in this topic creates a project containing both Maven and Gradle build infrastructure files by specifying the `--maven` and `--gradle` parameters in the command. @@ -102,6 +102,8 @@ where
- ```--force``` is an optional flag. If the flag is missing, then any file that the Galasa CLI tool tries to create which already exists causes a failure, and the original file is preserved. If this flag is used, then such files are silently over-written. Use this option carefully to avoid some of your files being over-written, resulting in the loss of some of your data. - ```--obr``` Creates an OBR project. For tests to run in the ecosystem they require compiled artifacts to be hosted in a Maven repository. The artifacts must be bundled as an OSGI bundle. Creating an OBR project makes it easier to move from running a test locally to running that test in an ecosystem. - ```--log -``` sends the trace and logging output that is generated by the tool to the console. +- ```--maven``` creates a project with a Maven project structure. +- ```--gradle``` creates a project with a Gradle project structure. ## Building the example project @@ -126,7 +128,7 @@ The built artifacts are typically placed in the `~/.m2/repository` in your home ## Understanding the generated artifacts -Running the example Galasa CLI `project create` command creates a number of files in the following standard folder structure: +Running the example Galasa CLI `project create` command with the `--maven` flag specified creates a number of files in the following standard folder structure: ``` .