Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2026-01-20 22:42:16 +01:00
Code Issues Packages Projects Releases Activity

Merged in feature/update_plugins (pull request #314)

Browse Source 
Feature/update plugins
This commit is contained in:
Rene Pfeuffer
2019-09-17 06:58:55 +00:00
parent 9ce3a6c00b c83a53cb3c
commit 1b280156d6
34 changed files with 1089 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
scm-core/src/main/java/sonia/scm/plugin/InstalledPlugin.java
View File

@@ -47,19 +47,20 @@ public final class InstalledPlugin implements Plugin
/**
* Constructs a new plugin wrapper.
*
* @param descriptor wrapped plugin
* @param descriptor wrapped plugin
* @param classLoader plugin class loader
* @param webResourceLoader web resource loader
* @param directory plugin directory
* @param core marked as core or not
*/
public InstalledPlugin(InstalledPluginDescriptor descriptor, ClassLoader classLoader,
WebResourceLoader webResourceLoader, Path directory)
WebResourceLoader webResourceLoader, Path directory, boolean core)
{
this.descriptor = descriptor;
this.classLoader = classLoader;
this.webResourceLoader = webResourceLoader;
this.directory = directory;
this.core = core;
}
//~--- get methods ----------------------------------------------------------
@@ -120,6 +121,10 @@ public final class InstalledPlugin implements Plugin
return webResourceLoader;
}
public boolean isCore() {
return core;
}
//~--- fields ---------------------------------------------------------------
/** plugin class loader */
@@ -133,4 +138,6 @@ public final class InstalledPlugin implements Plugin
/** plugin web resource loader */
private final WebResourceLoader webResourceLoader;
private final boolean core;
}

6
scm-ui-components/packages/ui-components/src/CardColumn.js
View File

@@ -48,6 +48,7 @@ type Props = {
footerRight: React.Node,
link?: string,
action?: () => void,
className?: string,
// context props
classes: any
@@ -72,13 +73,14 @@ class CardColumn extends React.Component<Props> {
contentRight,
footerLeft,
footerRight,
classes
classes,
className
} = this.props;
const link = this.createLink();
return (
<>
{link}
<article className={classNames("media", classes.inner)}>
<article className={classNames("media", className, classes.inner)}>
<figure className={classNames(classes.centerImage, "media-left")}>
{avatar}
</figure>

9
scm-ui-components/packages/ui-types/src/Plugin.js
View File

@@ -4,6 +4,7 @@ import type {Collection, Links} from "./hal";
export type Plugin = {
name: string,
version: string,
newVersion?: string,
displayName: string,
description?: string,
author: string,
@@ -24,3 +25,11 @@ export type PluginGroup = {
name: string,
plugins: Plugin[]
};
export type PendingPlugins = {
_links: Links,
_embedded: {
new: [],
update: [],
}
}

2
scm-ui-components/packages/ui-types/src/index.js
View File

@@ -25,7 +25,7 @@ export type { SubRepository, File } from "./Sources";
export type { SelectValue, AutocompleteObject } from "./Autocomplete";
export type { Plugin, PluginCollection, PluginGroup } from "./Plugin";
export type { Plugin, PluginCollection, PluginGroup, PendingPlugins } from "./Plugin";
export type { RepositoryRole } from "./RepositoryRole";

16
scm-ui/public/locales/de/admin.json
View File

@@ -29,22 +29,32 @@
"installedNavLink": "Installiert",
"availableNavLink": "Verfügbar"
},
"installPending": "Austehende Plugins installieren",
"executePending": "Austehende Plugin-Änderungen ausführen",
"noPlugins": "Keine Plugins gefunden.",
"modal": {
"title": "{{name}} Plugin installieren",
"title": {
"install": "{{name}} Plugin installieren",
"update": "{{name}} Plugin aktualisieren"
},
"restart": "Neustarten um Plugin zu aktivieren",
"install": "Installieren",
"update": "Aktualisieren",
"installQueue": "Werden installiert:",
"updateQueue": "Werden aktualisiert:",
"installAndRestart": "Installieren und Neustarten",
"updateAndRestart": "Aktualisieren und Neustarten",
"executeAndRestart": "Ausführen und Neustarten",
"abort": "Abbrechen",
"author": "Autor",
"version": "Version",
"currentVersion": "Installierte Version",
"newVersion": "Neue Version",
"dependencyNotification": "Mit diesem Plugin werden folgende Abhängigkeiten mit installiert, wenn sie noch nicht vorhanden sind!",
"dependencies": "Abhängigkeiten",
"successNotification": "Das Plugin wurde erfolgreich installiert. Um Änderungen an der UI zu sehen, muss die Seite neu geladen werden:",
"reload": "jetzt neu laden",
"restartNotification": "Der SCM-Manager Kontext sollte nur neu gestartet werden, wenn aktuell niemand damit arbeitet.",
"installPending": "Die folgenden Plugins werden installiert. Anschließend wird der SCM-Manager Kontext neu gestartet."
"executePending": "Die folgenden Plugin-Änderungen werden ausgeführt. Anschließend wird der SCM-Manager Kontext neu gestartet."
}
},
"repositoryRole": {

16
scm-ui/public/locales/en/admin.json
View File

@@ -29,22 +29,32 @@
"installedNavLink": "Installed",
"availableNavLink": "Available"
},
"installPending": "Install pending plugins",
"executePending": "Execute pending plugin changes",
"noPlugins": "No plugins found.",
"modal": {
"title": "Install {{name}} Plugin",
"title": {
"install": "Install {{name}} Plugin",
"update": "Update {{name}} Plugin"
},
"restart": "Restart to activate",
"install": "Install",
"update": "Update",
"installQueue": "Will be installed:",
"updateQueue": "Will be updated:",
"installAndRestart": "Install and Restart",
"updateAndRestart": "Update and Restart",
"executeAndRestart": "Execute and Restart",
"abort": "Abort",
"author": "Author",
"version": "Version",
"currentVersion": "Installed version",
"newVersion": "New version",
"dependencyNotification": "With this plugin, the following dependencies will be installed if they are not available yet!",
"dependencies": "Dependencies",
"successNotification": "Successful installed plugin. You have to reload the page, to see ui changes:",
"reload": "reload now",
"restartNotification": "You should only restart the scm-manager context if no one else is currently working with it.",
"installPending": "The following plugins will be installed and after installation the scm-manager context will be restarted."
"executePending": "The following plugin changes will be executed and after that the scm-manager context will be restarted."
}
},
"repositoryRole": {

18
scm-ui/src/admin/plugins/components/InstallPendingAction.js → scm-ui/src/admin/plugins/components/ExecutePendingAction.js
View File

@@ -1,12 +1,12 @@
// @flow
import React from "react";
import { Button } from "@scm-manager/ui-components";
import type { PluginCollection } from "@scm-manager/ui-types";
import type { PendingPlugins } from "@scm-manager/ui-types";
import { translate } from "react-i18next";
import InstallPendingModal from "./InstallPendingModal";
import ExecutePendingModal from "./ExecutePendingModal";
type Props = {
collection: PluginCollection,
pendingPlugins: PendingPlugins,
// context props
t: string => string
@@ -16,7 +16,7 @@ type State = {
showModal: boolean
};
class InstallPendingAction extends React.Component<Props, State> {
class ExecutePendingAction extends React.Component<Props, State> {
constructor(props: Props) {
super(props);
this.state = {
@@ -38,11 +38,11 @@ class InstallPendingAction extends React.Component<Props, State> {
renderModal = () => {
const { showModal } = this.state;
const { collection } = this.props;
const { pendingPlugins } = this.props;
if (showModal) {
return (
<InstallPendingModal
collection={collection}
<ExecutePendingModal
pendingPlugins={pendingPlugins}
onClose={this.closeModal}
/>
);
@@ -57,7 +57,7 @@ class InstallPendingAction extends React.Component<Props, State> {
{this.renderModal()}
<Button
color="primary"
label={t("plugins.installPending")}
label={t("plugins.executePending")}
action={this.openModal}
/>
</>
@@ -65,4 +65,4 @@ class InstallPendingAction extends React.Component<Props, State> {
}
}
export default translate("admin")(InstallPendingAction);
export default translate("admin")(ExecutePendingAction);

81
scm-ui/src/admin/plugins/components/InstallPendingModal.js → scm-ui/src/admin/plugins/components/ExecutePendingModal.js
View File

@@ -8,14 +8,14 @@ import {
Modal,
Notification
} from "@scm-manager/ui-components";
import type { PluginCollection } from "@scm-manager/ui-types";
import type { PendingPlugins } from "@scm-manager/ui-types";
import { translate } from "react-i18next";
import waitForRestart from "./waitForRestart";
import InstallSuccessNotification from "./InstallSuccessNotification";
import SuccessNotification from "./SuccessNotification";
type Props = {
onClose: () => void,
collection: PluginCollection,
pendingPlugins: PendingPlugins,
// context props
t: string => string
@@ -27,7 +27,7 @@ type State = {
error?: Error
};
class InstallPendingModal extends React.Component<Props, State> {
class ExecutePendingModal extends React.Component<Props, State> {
constructor(props: Props) {
super(props);
this.state = {
@@ -42,7 +42,7 @@ class InstallPendingModal extends React.Component<Props, State> {
if (error) {
return <ErrorNotification error={error} />;
} else if (success) {
return <InstallSuccessNotification />;
return <SuccessNotification />;
} else {
return (
<Notification type="warning">
@@ -52,14 +52,14 @@ class InstallPendingModal extends React.Component<Props, State> {
}
};
installAndRestart = () => {
const { collection } = this.props;
executeAndRestart = () => {
const { pendingPlugins } = this.props;
this.setState({
loading: true
});
apiClient
.post(collection._links.installPending.href)
.post(pendingPlugins._links.execute.href)
.then(waitForRestart)
.then(() => {
this.setState({
@@ -77,22 +77,57 @@ class InstallPendingModal extends React.Component<Props, State> {
});
};
renderInstallQueue = () => {
const { pendingPlugins, t } = this.props;
return (
<>
{pendingPlugins._embedded &&
pendingPlugins._embedded.new.length > 0 && (
<>
<strong>{t("plugins.modal.installQueue")}</strong>
<ul>
{pendingPlugins._embedded.new
.filter(plugin => plugin.pending)
.map(plugin => (
<li key={plugin.name}>{plugin.name}</li>
))}
</ul>
</>
)}
</>
);
};
renderUpdateQueue = () => {
const { pendingPlugins, t } = this.props;
return (
<>
{pendingPlugins._embedded &&
pendingPlugins._embedded.update.length > 0 && (
<>
<strong>{t("plugins.modal.updateQueue")}</strong>
<ul>
{pendingPlugins._embedded.update
.filter(plugin => plugin.pending)
.map(plugin => (
<li key={plugin.name}>{plugin.name}</li>
))}
</ul>
</>
)}
</>
);
};
renderBody = () => {
const { collection, t } = this.props;
const { t } = this.props;
return (
<>
<div className="media">
<div className="content">
<p>{t("plugins.modal.installPending")}</p>
<ul>
{collection._embedded.plugins
.filter(plugin => plugin.pending)
.map(plugin => (
<li key={plugin.name} className="has-text-weight-bold">
{plugin.name}
</li>
))}
</ul>
<p>{t("plugins.modal.executePending")}</p>
{this.renderInstallQueue()}
{this.renderUpdateQueue()}
</div>
</div>
<div className="media">{this.renderNotifications()}</div>
@@ -107,9 +142,9 @@ class InstallPendingModal extends React.Component<Props, State> {
<ButtonGroup>
<Button
color="warning"
label={t("plugins.modal.installAndRestart")}
label={t("plugins.modal.executeAndRestart")}
loading={loading}
action={this.installAndRestart}
action={this.executeAndRestart}
disabled={error || success}
/>
<Button label={t("plugins.modal.abort")} action={onClose} />
@@ -121,7 +156,7 @@ class InstallPendingModal extends React.Component<Props, State> {
const { onClose, t } = this.props;
return (
<Modal
title={t("plugins.modal.installAndRestart")}
title={t("plugins.modal.executeAndRestart")}
closeFunction={onClose}
body={this.renderBody()}
footer={this.renderFooter()}
@@ -131,4 +166,4 @@ class InstallPendingModal extends React.Component<Props, State> {
}
}
export default translate("admin")(InstallPendingModal);
export default translate("admin")(ExecutePendingModal);

84
scm-ui/src/admin/plugins/components/PluginEntry.js
View File

@@ -4,8 +4,14 @@ import injectSheet from "react-jss";
import type { Plugin } from "@scm-manager/ui-types";
import { CardColumn } from "@scm-manager/ui-components";
import PluginAvatar from "./PluginAvatar";
import PluginModal from "./PluginModal";
import classNames from "classnames";
import PluginModal from "./PluginModal";
const PluginAction = {
INSTALL: "install",
UPDATE: "update"
};
type Props = {
plugin: Plugin,
@@ -22,12 +28,23 @@ type State = {
const styles = {
link: {
cursor: "pointer",
pointerEvents: "all"
pointerEvents: "all",
padding: "0.5rem",
border: "solid 1px var(--dark-25)",
borderRadius: "4px",
"&:hover": {
borderColor: "var(--dark-50)"
}
},
spinner: {
topRight: {
position: "absolute",
right: 0,
top: 0
},
layout: {
"& .level": {
paddingBottom: "0.5rem"
}
}
};
@@ -59,17 +76,54 @@ class PluginEntry extends React.Component<Props, State> {
return plugin._links && plugin._links.install && plugin._links.install.href;
};
createFooterLeft = () => {
isUpdatable = () => {
const { plugin } = this.props;
return plugin._links && plugin._links.update && plugin._links.update.href;
};
createActionbar = () => {
const { classes } = this.props;
if (this.isInstallable()) {
return (
<span
className={classNames(classes.link, "level-item")}
className={classNames(classes.link, classes.topRight, "level-item")}
onClick={this.toggleModal}
>
<i className="fas fa-download has-text-info" />
</span>
);
} else if (this.isUpdatable()) {
return (
<span
className={classNames(classes.link, classes.topRight, "level-item")}
onClick={this.toggleModal}
>
<i className="fas fa-sync-alt has-text-info" />
</span>
);
}
};
renderModal = () => {
const { plugin, refresh } = this.props;
if (this.isInstallable()) {
return (
<PluginModal
plugin={plugin}
pluginAction={PluginAction.INSTALL}
refresh={refresh}
onClose={this.toggleModal}
/>
);
} else if (this.isUpdatable()) {
return (
<PluginModal
plugin={plugin}
pluginAction={PluginAction.UPDATE}
refresh={refresh}
onClose={this.toggleModal}
/>
);
}
};
@@ -77,7 +131,7 @@ class PluginEntry extends React.Component<Props, State> {
const { plugin, classes } = this.props;
if (plugin.pending) {
return (
<span className={classes.spinner}>
<span className={classes.topRight}>
<i className="fas fa-spinner fa-spin has-text-info" />
</span>
);
@@ -86,29 +140,25 @@ class PluginEntry extends React.Component<Props, State> {
};
render() {
const { plugin, refresh } = this.props;
const { plugin, classes } = this.props;
const { showModal } = this.state;
const avatar = this.createAvatar(plugin);
const footerLeft = this.createFooterLeft();
const actionbar = this.createActionbar();
const footerRight = this.createFooterRight(plugin);
const modal = showModal ? (
<PluginModal
plugin={plugin}
refresh={refresh}
onClose={this.toggleModal}
/>
) : null;
const modal = showModal ? this.renderModal() : null;
return (
<>
<CardColumn
className={classes.layout}
action={this.isInstallable() ? this.toggleModal : null}
avatar={avatar}
title={plugin.displayName ? plugin.displayName : plugin.name}
description={plugin.description}
contentRight={this.createPendingSpinner()}
footerLeft={footerLeft}
contentRight={
plugin.pending ? this.createPendingSpinner() : actionbar
}
footerRight={footerRight}
/>
{modal}

128
scm-ui/src/admin/plugins/components/PluginModal.js
View File

@@ -15,10 +15,11 @@ import {
} from "@scm-manager/ui-components";
import classNames from "classnames";
import waitForRestart from "./waitForRestart";
import InstallSuccessNotification from "./InstallSuccessNotification";
import SuccessNotification from "./SuccessNotification";
type Props = {
plugin: Plugin,
pluginAction: string,
refresh: () => void,
onClose: () => void,
@@ -37,9 +38,14 @@ type State = {
const styles = {
userLabelAlignment: {
textAlign: "left",
marginRight: 0,
marginRight: 0
},
userLabelMarginSmall: {
minWidth: "5.5em"
},
userLabelMarginLarge: {
minWidth: "9em"
},
userFieldFlex: {
flexGrow: 4
}
@@ -55,7 +61,7 @@ class PluginModal extends React.Component<Props, State> {
};
}
onInstallSuccess = () => {
onSuccess = () => {
const { restart } = this.state;
const { refresh, onClose } = this.props;
@@ -87,16 +93,28 @@ class PluginModal extends React.Component<Props, State> {
}
};
install = (e: Event) => {
createPluginActionLink = () => {
const { plugin, pluginAction } = this.props;
const { restart } = this.state;
const { plugin } = this.props;
let pluginActionLink = "";
if (pluginAction === "install") {
pluginActionLink = plugin._links.install.href;
} else if (pluginAction === "update") {
pluginActionLink = plugin._links.update.href;
}
return pluginActionLink + "?restart=" + restart.toString();
};
handlePluginAction = (e: Event) => {
this.setState({
loading: true
});
e.preventDefault();
apiClient
.post(plugin._links.install.href + "?restart=" + restart.toString())
.then(this.onInstallSuccess)
.post(this.createPluginActionLink())
.then(this.onSuccess)
.catch(error => {
this.setState({
loading: false,
@@ -106,21 +124,21 @@ class PluginModal extends React.Component<Props, State> {
};
footer = () => {
const { onClose, t } = this.props;
const { pluginAction, onClose, t } = this.props;
const { loading, error, restart, success } = this.state;
let color = "primary";
let label = "plugins.modal.install";
let label = `plugins.modal.${pluginAction}`;
if (restart) {
color = "warning";
label = "plugins.modal.installAndRestart";
label = `plugins.modal.${pluginAction}AndRestart`;
}
return (
<ButtonGroup>
<Button
label={t(label)}
color={color}
action={this.install}
action={this.handlePluginAction}
loading={loading}
disabled={!!error || success}
/>
@@ -162,7 +180,7 @@ class PluginModal extends React.Component<Props, State> {
} else if (success) {
return (
<div className="media">
<InstallSuccessNotification />
<SuccessNotification />
</div>
);
} else if (restart) {
@@ -185,7 +203,7 @@ class PluginModal extends React.Component<Props, State> {
render() {
const { restart } = this.state;
const { plugin, onClose, classes, t } = this.props;
const { plugin, pluginAction, onClose, classes, t } = this.props;
const body = (
<>
@@ -200,6 +218,9 @@ class PluginModal extends React.Component<Props, State> {
<div
className={classNames(
classes.userLabelAlignment,
pluginAction === "install"
? classes.userLabelMarginSmall
: classes.userLabelMarginLarge,
"field-label is-inline-flex"
)}
>
@@ -214,24 +235,69 @@ class PluginModal extends React.Component<Props, State> {
{plugin.author}
</div>
</div>
<div className="field is-horizontal">
<div
className={classNames(
classes.userLabelAlignment,
"field-label is-inline-flex"
)}
>
{t("plugins.modal.version")}:
{pluginAction === "install" && (
<div className="field is-horizontal">
<div
className={classNames(
classes.userLabelAlignment,
classes.userLabelMarginSmall,
"field-label is-inline-flex"
)}
>
{t("plugins.modal.version")}:
</div>
<div
className={classNames(
classes.userFieldFlex,
"field-body is-inline-flex"
)}
>
{plugin.version}
</div>
</div>
<div
className={classNames(
classes.userFieldFlex,
"field-body is-inline-flex"
)}
>
{plugin.version}
</div>
</div>
)}
{pluginAction === "update" && (
<>
<div className="field is-horizontal">
<div
className={classNames(
classes.userLabelAlignment,
classes.userLabelMarginLarge,
"field-label is-inline-flex"
)}
>
{t("plugins.modal.currentVersion")}:
</div>
<div
className={classNames(
classes.userFieldFlex,
"field-body is-inline-flex"
)}
>
{plugin.version}
</div>
</div>
<div className="field is-horizontal">
<div
className={classNames(
classes.userLabelAlignment,
classes.userLabelMarginLarge,
"field-label is-inline-flex"
)}
>
{t("plugins.modal.newVersion")}:
</div>
<div
className={classNames(
classes.userFieldFlex,
"field-body is-inline-flex"
)}
>
{plugin.newVersion}
</div>
</div>
</>
)}
{this.renderDependencies()}
</div>
@@ -252,7 +318,7 @@ class PluginModal extends React.Component<Props, State> {
return (
<Modal
title={t("plugins.modal.title", {
title={t(`plugins.modal.title.${pluginAction}`, {
name: plugin.displayName ? plugin.displayName : plugin.name
})}
closeFunction={() => onClose()}

0
scm-ui/src/admin/plugins/components/InstallSuccessNotification.js → scm-ui/src/admin/plugins/components/SuccessNotification.js
View File

64
scm-ui/src/admin/plugins/containers/PluginsOverview.js
View File

@@ -3,28 +3,31 @@ import * as React from "react";
import { connect } from "react-redux";
import { translate } from "react-i18next";
import { compose } from "redux";
import type { PluginCollection } from "@scm-manager/ui-types";
import type { PendingPlugins, PluginCollection } from "@scm-manager/ui-types";
import {
ErrorNotification,
Loading,
Title,
Subtitle,
Notification,
ErrorNotification
Subtitle,
Title
} from "@scm-manager/ui-components";
import {
fetchPendingPlugins,
fetchPluginsByLink,
getFetchPluginsFailure,
getPendingPlugins,
getPluginCollection,
isFetchPluginsPending
} from "../modules/plugins";
import PluginsList from "../components/PluginList";
import {
getAvailablePluginsLink,
getInstalledPluginsLink
getInstalledPluginsLink,
getPendingPluginsLink
} from "../../../modules/indexResource";
import PluginTopActions from "../components/PluginTopActions";
import PluginBottomActions from "../components/PluginBottomActions";
import InstallPendingAction from "../components/InstallPendingAction";
import ExecutePendingAction from "../components/ExecutePendingAction";
type Props = {
loading: boolean,
@@ -34,12 +37,15 @@ type Props = {
installed: boolean,
availablePluginsLink: string,
installedPluginsLink: string,
pendingPluginsLink: string,
pendingPlugins: PendingPlugins,
// context objects
t: string => string,
// dispatched functions
fetchPluginsByLink: (link: string) => void
fetchPluginsByLink: (link: string) => void,
fetchPendingPlugins: (link: string) => void
};
class PluginsOverview extends React.Component<Props> {
@@ -48,15 +54,16 @@ class PluginsOverview extends React.Component<Props> {
installed,
fetchPluginsByLink,
availablePluginsLink,
installedPluginsLink
installedPluginsLink,
pendingPluginsLink,
fetchPendingPlugins
} = this.props;
fetchPluginsByLink(installed ? installedPluginsLink : availablePluginsLink);
fetchPendingPlugins(pendingPluginsLink);
}
componentDidUpdate(prevProps) {
const {
installed,
} = this.props;
const { installed } = this.props;
if (prevProps.installed !== installed) {
this.fetchPlugins();
}
@@ -67,11 +74,12 @@ class PluginsOverview extends React.Component<Props> {
installed,
fetchPluginsByLink,
availablePluginsLink,
installedPluginsLink
installedPluginsLink,
pendingPluginsLink,
fetchPendingPlugins
} = this.props;
fetchPluginsByLink(
installed ? installedPluginsLink : availablePluginsLink
);
fetchPluginsByLink(installed ? installedPluginsLink : availablePluginsLink);
fetchPendingPlugins(pendingPluginsLink);
};
renderHeader = (actions: React.Node) => {
@@ -101,9 +109,13 @@ class PluginsOverview extends React.Component<Props> {
};
createActions = () => {
const { collection } = this.props;
if (collection._links.installPending) {
return <InstallPendingAction collection={collection} />;
const { pendingPlugins } = this.props;
if (
pendingPlugins &&
pendingPlugins._links &&
pendingPlugins._links.execute
) {
return <ExecutePendingAction pendingPlugins={pendingPlugins} />;
}
return null;
};
@@ -134,7 +146,12 @@ class PluginsOverview extends React.Component<Props> {
const { collection, t } = this.props;
if (collection._embedded && collection._embedded.plugins.length > 0) {
return <PluginsList plugins={collection._embedded.plugins} refresh={this.fetchPlugins} />;
return (
<PluginsList
plugins={collection._embedded.plugins}
refresh={this.fetchPlugins}
/>
);
}
return <Notification type="info">{t("plugins.noPlugins")}</Notification>;
}
@@ -146,13 +163,17 @@ const mapStateToProps = state => {
const error = getFetchPluginsFailure(state);
const availablePluginsLink = getAvailablePluginsLink(state);
const installedPluginsLink = getInstalledPluginsLink(state);
const pendingPluginsLink = getPendingPluginsLink(state);
const pendingPlugins = getPendingPlugins(state);
return {
collection,
loading,
error,
availablePluginsLink,
installedPluginsLink
installedPluginsLink,
pendingPluginsLink,
pendingPlugins
};
};
@@ -160,6 +181,9 @@ const mapDispatchToProps = dispatch => {
return {
fetchPluginsByLink: (link: string) => {
dispatch(fetchPluginsByLink(link));
},
fetchPendingPlugins: (link: string) => {
dispatch(fetchPendingPlugins(link));
}
};
};

68
scm-ui/src/admin/plugins/modules/plugins.js
View File

@@ -15,6 +15,17 @@ export const FETCH_PLUGIN_PENDING = `${FETCH_PLUGIN}_${types.PENDING_SUFFIX}`;
export const FETCH_PLUGIN_SUCCESS = `${FETCH_PLUGIN}_${types.SUCCESS_SUFFIX}`;
export const FETCH_PLUGIN_FAILURE = `${FETCH_PLUGIN}_${types.FAILURE_SUFFIX}`;
export const FETCH_PENDING_PLUGINS = "scm/plugins/FETCH_PENDING_PLUGINS";
export const FETCH_PENDING_PLUGINS_PENDING = `${FETCH_PENDING_PLUGINS}_${
types.PENDING_SUFFIX
}`;
export const FETCH_PENDING_PLUGINS_SUCCESS = `${FETCH_PENDING_PLUGINS}_${
types.SUCCESS_SUFFIX
}`;
export const FETCH_PENDING_PLUGINS_FAILURE = `${FETCH_PENDING_PLUGINS}_${
types.FAILURE_SUFFIX
}`;
// fetch plugins
export function fetchPluginsByLink(link: string) {
return function(dispatch: any) {
@@ -105,8 +116,44 @@ export function fetchPluginFailure(name: string, error: Error): Action {
};
}
// fetch pending plugins
export function fetchPendingPlugins(link: string) {
return function(dispatch: any) {
dispatch(fetchPendingPluginsPending());
return apiClient
.get(link)
.then(response => response.json())
.then(PendingPlugins => {
dispatch(fetchPendingPluginsSuccess(PendingPlugins));
})
.catch(err => {
dispatch(fetchPendingPluginsFailure(err));
});
};
}
export function fetchPendingPluginsPending(): Action {
return {
type: FETCH_PENDING_PLUGINS_PENDING
};
}
export function fetchPendingPluginsSuccess(PendingPlugins: {}): Action {
return {
type: FETCH_PENDING_PLUGINS_SUCCESS,
payload: PendingPlugins
};
}
export function fetchPendingPluginsFailure(err: Error): Action {
return {
type: FETCH_PENDING_PLUGINS_FAILURE,
payload: err
};
}
// reducer
function normalizeByName(pluginCollection: PluginCollection) {
function normalizeByName(state: Object, pluginCollection: PluginCollection) {
const names = [];
const byNames = {};
for (const plugin of pluginCollection._embedded.plugins) {
@@ -114,6 +161,7 @@ function normalizeByName(pluginCollection: PluginCollection) {
byNames[plugin.name] = plugin;
}
return {
...state,
list: {
...pluginCollection,
_embedded: {
@@ -144,9 +192,11 @@ export default function reducer(
switch (action.type) {
case FETCH_PLUGINS_SUCCESS:
return normalizeByName(action.payload);
return normalizeByName(state, action.payload);
case FETCH_PLUGIN_SUCCESS:
return reducerByNames(state, action.payload);
case FETCH_PENDING_PLUGINS_SUCCESS:
return { ...state, pending: action.payload };
default:
return state;
}
@@ -189,3 +239,17 @@ export function isFetchPluginPending(state: Object, name: string) {
export function getFetchPluginFailure(state: Object, name: string) {
return getFailure(state, FETCH_PLUGIN, name);
}
export function getPendingPlugins(state: Object) {
if (state.plugins && state.plugins.pending) {
return state.plugins.pending;
}
}
export function isFetchPendingPluginsPending(state: Object) {
return isPending(state, FETCH_PENDING_PLUGINS);
}
export function getFetchPendingPluginsFailure(state: Object) {
return getFailure(state, FETCH_PENDING_PLUGINS);
}

4
scm-ui/src/modules/indexResource.js
View File

@@ -124,6 +124,10 @@ export function getInstalledPluginsLink(state: Object) {
return getLink(state, "installedPlugins");
}
export function getPendingPluginsLink(state: Object) {
return getLink(state, "pendingPlugins");
}
export function getMeLink(state: Object) {
return getLink(state, "me");
}

22
scm-webapp/src/main/java/sonia/scm/api/v2/resources/AvailablePluginResource.java
View File

@@ -4,7 +4,7 @@ import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
import com.webcohesion.enunciate.metadata.rs.TypeHint;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.InstalledPluginDescriptor;
import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.PluginManager;
import sonia.scm.plugin.PluginPermissions;
import sonia.scm.web.VndMediaType;
@@ -19,6 +19,7 @@ import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import static sonia.scm.ContextEntry.ContextBuilder.entity;
import static sonia.scm.NotFoundException.notFound;
@@ -51,10 +52,15 @@ public class AvailablePluginResource {
@Produces(VndMediaType.PLUGIN_COLLECTION)
public Response getAvailablePlugins() {
PluginPermissions.read().check();
List<AvailablePlugin> available = pluginManager.getAvailable();
List<InstalledPlugin> installed = pluginManager.getInstalled();
List<AvailablePlugin> available = pluginManager.getAvailable().stream().filter(a -> notInstalled(a, installed)).collect(Collectors.toList());
return Response.ok(collectionMapper.mapAvailable(available)).build();
}
private boolean notInstalled(AvailablePlugin a, List<InstalledPlugin> installed) {
return installed.stream().noneMatch(installedPlugin -> installedPlugin.getDescriptor().getInformation().getName().equals(a.getDescriptor().getInformation().getName()));
}
/**
* Returns available plugin.
*
@@ -95,16 +101,4 @@ public class AvailablePluginResource {
pluginManager.install(name, restartAfterInstallation);
return Response.ok().build();
}
@POST
@Path("/install-pending")
@StatusCodes({
@ResponseCode(code = 200, condition = "success"),
@ResponseCode(code = 500, condition = "internal server error")
})
public Response installPending() {
PluginPermissions.manage().check();
pluginManager.installPendingAndRestart();
return Response.ok().build();
}
}

3
scm-webapp/src/main/java/sonia/scm/api/v2/resources/IndexDtoGenerator.java
View File

@@ -54,6 +54,9 @@ public class IndexDtoGenerator extends HalAppenderMapper {
builder.single(link("installedPlugins", resourceLinks.installedPluginCollection().self()));
builder.single(link("availablePlugins", resourceLinks.availablePluginCollection().self()));
}
if (PluginPermissions.manage().isPermitted()) {
builder.single(link("pendingPlugins", resourceLinks.pendingPluginCollection().self()));
}
if (UserPermissions.list().isPermitted()) {
builder.single(link("users", resourceLinks.userCollection().self()));
}

8
scm-webapp/src/main/java/sonia/scm/api/v2/resources/InstalledPluginResource.java
View File

@@ -3,8 +3,8 @@ package sonia.scm.api.v2.resources;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
import com.webcohesion.enunciate.metadata.rs.TypeHint;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.InstalledPluginDescriptor;
import sonia.scm.plugin.PluginManager;
import sonia.scm.plugin.PluginPermissions;
import sonia.scm.web.VndMediaType;
@@ -50,7 +50,8 @@ public class InstalledPluginResource {
public Response getInstalledPlugins() {
PluginPermissions.read().check();
List<InstalledPlugin> plugins = pluginManager.getInstalled();
return Response.ok(collectionMapper.mapInstalled(plugins)).build();
List<AvailablePlugin> available = pluginManager.getAvailable();
return Response.ok(collectionMapper.mapInstalled(plugins, available)).build();
}
/**
@@ -72,8 +73,9 @@ public class InstalledPluginResource {
public Response getInstalledPlugin(@PathParam("name") String name) {
PluginPermissions.read().check();
Optional<InstalledPlugin> pluginDto = pluginManager.getInstalled(name);
List<AvailablePlugin> available = pluginManager.getAvailable();
if (pluginDto.isPresent()) {
return Response.ok(mapper.mapInstalled(pluginDto.get())).build();
return Response.ok(mapper.mapInstalled(pluginDto.get(), available)).build();
} else {
throw notFound(entity("Plugin", name));
}

108
scm-webapp/src/main/java/sonia/scm/api/v2/resources/PendingPluginResource.java Normal file
View File

@@ -0,0 +1,108 @@
package sonia.scm.api.v2.resources;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
import de.otto.edison.hal.Embedded;
import de.otto.edison.hal.HalRepresentation;
import de.otto.edison.hal.Links;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.PluginManager;
import sonia.scm.plugin.PluginPermissions;
import sonia.scm.web.VndMediaType;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;
import static de.otto.edison.hal.Link.link;
import static de.otto.edison.hal.Links.linkingTo;
import static java.util.stream.Collectors.toList;
public class PendingPluginResource {
private final PluginManager pluginManager;
private final ResourceLinks resourceLinks;
private final PluginDtoMapper mapper;
@Inject
public PendingPluginResource(PluginManager pluginManager, ResourceLinks resourceLinks, PluginDtoMapper mapper) {
this.pluginManager = pluginManager;
this.resourceLinks = resourceLinks;
this.mapper = mapper;
}
@GET
@Path("")
@StatusCodes({
@ResponseCode(code = 200, condition = "success"),
@ResponseCode(code = 500, condition = "internal server error")
})
@Produces(VndMediaType.PLUGIN_COLLECTION)
public Response getPending() {
PluginPermissions.manage().check();
List<AvailablePlugin> pending = pluginManager
.getAvailable()
.stream()
.filter(AvailablePlugin::isPending)
.collect(toList());
List<InstalledPlugin> installed = pluginManager.getInstalled();
Stream<AvailablePlugin> newPlugins = pending
.stream()
.filter(a -> !contains(installed, a));
Stream<InstalledPlugin> updatePlugins = installed
.stream()
.filter(i -> contains(pending, i));
Links.Builder linksBuilder = linkingTo().self(resourceLinks.pendingPluginCollection().self());
List<PluginDto> newPluginDtos = newPlugins.map(mapper::mapAvailable).collect(toList());
List<PluginDto> updatePluginDtos = updatePlugins.map(i -> mapper.mapInstalled(i, pending)).collect(toList());
if (newPluginDtos.size() > 0 || updatePluginDtos.size() > 0) {
linksBuilder.single(link("execute", resourceLinks.pendingPluginCollection().installPending()));
}
Embedded.Builder embedded = Embedded.embeddedBuilder();
embedded.with("new", newPluginDtos);
embedded.with("update", updatePluginDtos);
return Response.ok(new HalRepresentation(linksBuilder.build(), embedded.build())).build();
}
private boolean contains(Collection<InstalledPlugin> installedPlugins, AvailablePlugin availablePlugin) {
return installedPlugins
.stream()
.anyMatch(installedPlugin -> haveSameName(installedPlugin, availablePlugin));
}
private boolean contains(Collection<AvailablePlugin> availablePlugins, InstalledPlugin installedPlugin) {
return availablePlugins
.stream()
.anyMatch(availablePlugin -> haveSameName(installedPlugin, availablePlugin));
}
private boolean haveSameName(InstalledPlugin installedPlugin, AvailablePlugin availablePlugin) {
return installedPlugin.getDescriptor().getInformation().getName().equals(availablePlugin.getDescriptor().getInformation().getName());
}
@POST
@Path("/install")
@StatusCodes({
@ResponseCode(code = 200, condition = "success"),
@ResponseCode(code = 500, condition = "internal server error")
})
public Response installPending() {
PluginPermissions.manage().check();
pluginManager.installPendingAndRestart();
return Response.ok().build();
}
}

5
scm-webapp/src/main/java/sonia/scm/api/v2/resources/PluginDto.java
View File

@@ -1,5 +1,6 @@
package sonia.scm.api.v2.resources;
import com.fasterxml.jackson.annotation.JsonInclude;
import de.otto.edison.hal.HalRepresentation;
import de.otto.edison.hal.Links;
import lombok.Getter;
@@ -16,12 +17,16 @@ public class PluginDto extends HalRepresentation {
private String name;
private String version;
@JsonInclude(JsonInclude.Include.NON_NULL)
private String newVersion;
private String displayName;
private String description;
private String author;
private String category;
private String avatarUrl;
private boolean pending;
@JsonInclude(JsonInclude.Include.NON_NULL)
private Boolean core;
private Set<String> dependencies;
public PluginDto(Links links) {

11
scm-webapp/src/main/java/sonia/scm/api/v2/resources/PluginDtoCollectionMapper.java
View File

@@ -26,8 +26,11 @@ public class PluginDtoCollectionMapper {
this.mapper = mapper;
}
public HalRepresentation mapInstalled(List<InstalledPlugin> plugins) {
List<PluginDto> dtos = plugins.stream().map(mapper::mapInstalled).collect(toList());
public HalRepresentation mapInstalled(List<InstalledPlugin> plugins, List<AvailablePlugin> availablePlugins) {
List<PluginDto> dtos = plugins
.stream()
.map(i -> mapper.mapInstalled(i, availablePlugins))
.collect(toList());
return new HalRepresentation(createInstalledPluginsLinks(), embedDtos(dtos));
}
@@ -50,10 +53,6 @@ public class PluginDtoCollectionMapper {
Links.Builder linksBuilder = linkingTo()
.with(Links.linkingTo().self(baseUrl).build());
if (PluginPermissions.manage().isPermitted() && containsPending(plugins)) {
linksBuilder.single(Link.link("installPending", resourceLinks.availablePluginCollection().installPending()));
}
return linksBuilder.build();
}

34
scm-webapp/src/main/java/sonia/scm/api/v2/resources/PluginDtoMapper.java
View File

@@ -11,6 +11,9 @@ import sonia.scm.plugin.PluginPermissions;
import javax.inject.Inject;
import java.util.List;
import java.util.Optional;
import static de.otto.edison.hal.Link.link;
import static de.otto.edison.hal.Links.linkingTo;
@@ -22,8 +25,8 @@ public abstract class PluginDtoMapper {
public abstract void map(PluginInformation plugin, @MappingTarget PluginDto dto);
public PluginDto mapInstalled(InstalledPlugin plugin) {
PluginDto dto = createDtoForInstalled(plugin);
public PluginDto mapInstalled(InstalledPlugin plugin, List<AvailablePlugin> availablePlugins) {
PluginDto dto = createDtoForInstalled(plugin, availablePlugins);
map(dto, plugin);
return dto;
}
@@ -57,13 +60,36 @@ public abstract class PluginDtoMapper {
return new PluginDto(links.build());
}
private PluginDto createDtoForInstalled(InstalledPlugin plugin) {
private PluginDto createDtoForInstalled(InstalledPlugin plugin, List<AvailablePlugin> availablePlugins) {
PluginInformation information = plugin.getDescriptor().getInformation();
Optional<AvailablePlugin> availablePlugin = checkForUpdates(plugin, availablePlugins);
Links.Builder links = linkingTo()
.self(resourceLinks.installedPlugin()
.self(information.getName()));
if (!plugin.isCore()
&& availablePlugin.isPresent()
&& !availablePlugin.get().isPending()
&& PluginPermissions.manage().isPermitted()
) {
links.single(link("update", resourceLinks.availablePlugin().install(information.getName())));
}
return new PluginDto(links.build());
PluginDto dto = new PluginDto(links.build());
availablePlugin.ifPresent(value -> {
dto.setNewVersion(value.getDescriptor().getInformation().getVersion());
dto.setPending(value.isPending());
});
dto.setCore(plugin.isCore());
return dto;
}
private Optional<AvailablePlugin> checkForUpdates(InstalledPlugin plugin, List<AvailablePlugin> availablePlugins) {
return availablePlugins.stream()
.filter(a -> a.getDescriptor().getInformation().getName().equals(plugin.getDescriptor().getInformation().getName()))
.findAny();
}
}

7
scm-webapp/src/main/java/sonia/scm/api/v2/resources/PluginRootResource.java
View File

@@ -9,11 +9,13 @@ public class PluginRootResource {
private Provider<InstalledPluginResource> installedPluginResourceProvider;
private Provider<AvailablePluginResource> availablePluginResourceProvider;
private Provider<PendingPluginResource> pendingPluginResourceProvider;
@Inject
public PluginRootResource(Provider<InstalledPluginResource> installedPluginResourceProvider, Provider<AvailablePluginResource> availablePluginResourceProvider) {
public PluginRootResource(Provider<InstalledPluginResource> installedPluginResourceProvider, Provider<AvailablePluginResource> availablePluginResourceProvider, Provider<PendingPluginResource> pendingPluginResourceProvider) {
this.installedPluginResourceProvider = installedPluginResourceProvider;
this.availablePluginResourceProvider = availablePluginResourceProvider;
this.pendingPluginResourceProvider = pendingPluginResourceProvider;
}
@Path("/installed")
@@ -23,4 +25,7 @@ public class PluginRootResource {
@Path("/available")
public AvailablePluginResource availablePlugins() { return availablePluginResourceProvider.get(); }
@Path("/pending")
public PendingPluginResource pendingPlugins() { return pendingPluginResourceProvider.get(); }
}

20
scm-webapp/src/main/java/sonia/scm/api/v2/resources/ResourceLinks.java
View File

@@ -715,12 +715,28 @@ class ResourceLinks {
availablePluginCollectionLinkBuilder = new LinkBuilder(pathInfo, PluginRootResource.class, AvailablePluginResource.class);
}
String self() {
return availablePluginCollectionLinkBuilder.method("availablePlugins").parameters().method("getAvailablePlugins").parameters().href();
}
}
public PendingPluginCollectionLinks pendingPluginCollection() {
return new PendingPluginCollectionLinks(scmPathInfoStore.get());
}
static class PendingPluginCollectionLinks {
private final LinkBuilder pendingPluginCollectionLinkBuilder;
PendingPluginCollectionLinks(ScmPathInfo pathInfo) {
pendingPluginCollectionLinkBuilder = new LinkBuilder(pathInfo, PluginRootResource.class, PendingPluginResource.class);
}
String installPending() {
return availablePluginCollectionLinkBuilder.method("availablePlugins").parameters().method("installPending").parameters().href();
return pendingPluginCollectionLinkBuilder.method("pendingPlugins").parameters().method("installPending").parameters().href();
}
String self() {
return availablePluginCollectionLinkBuilder.method("availablePlugins").parameters().method("getAvailablePlugins").parameters().href();
return pendingPluginCollectionLinkBuilder.method("pendingPlugins").parameters().method("getPending").parameters().href();
}
}

44
scm-webapp/src/main/java/sonia/scm/plugin/DefaultPluginManager.java
View File

@@ -40,8 +40,10 @@ import com.google.inject.Singleton;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sonia.scm.NotFoundException;
import sonia.scm.ScmConstraintViolationException;
import sonia.scm.event.ScmEventBus;
import sonia.scm.lifecycle.RestartEvent;
import sonia.scm.version.Version;
//~--- JDK imports ------------------------------------------------------------
import javax.inject.Inject;
@@ -53,6 +55,7 @@ import java.util.function.Predicate;
import java.util.stream.Collectors;
import static sonia.scm.ContextEntry.ContextBuilder.entity;
import static sonia.scm.ScmConstraintViolationException.Builder.doThrow;
/**
*
@@ -83,7 +86,7 @@ public class DefaultPluginManager implements PluginManager {
return center.getAvailable()
.stream()
.filter(filterByName(name))
.filter(this::isNotInstalled)
.filter(this::isNotInstalledOrMoreUpToDate)
.map(p -> getPending(name).orElse(p))
.findFirst();
}
@@ -116,7 +119,7 @@ public class DefaultPluginManager implements PluginManager {
PluginPermissions.read().check();
return center.getAvailable()
.stream()
.filter(this::isNotInstalled)
.filter(this::isNotInstalledOrMoreUpToDate)
.map(p -> getPending(p.getDescriptor().getInformation().getName()).orElse(p))
.collect(Collectors.toList());
}
@@ -125,13 +128,26 @@ public class DefaultPluginManager implements PluginManager {
return plugin -> name.equals(plugin.getDescriptor().getInformation().getName());
}
private boolean isNotInstalled(AvailablePlugin availablePlugin) {
return !getInstalled(availablePlugin.getDescriptor().getInformation().getName()).isPresent();
private boolean isNotInstalledOrMoreUpToDate(AvailablePlugin availablePlugin) {
return getInstalled(availablePlugin.getDescriptor().getInformation().getName())
.map(installedPlugin -> availableIsMoreUpToDateThanInstalled(availablePlugin, installedPlugin))
.orElse(true);
}
private boolean availableIsMoreUpToDateThanInstalled(AvailablePlugin availablePlugin, InstalledPlugin installed) {
return Version.parse(availablePlugin.getDescriptor().getInformation().getVersion()).isNewer(installed.getDescriptor().getInformation().getVersion());
}
@Override
public void install(String name, boolean restartAfterInstallation) {
PluginPermissions.manage().check();
getInstalled(name)
.map(InstalledPlugin::isCore)
.ifPresent(
core -> doThrow().violation("plugin is a core plugin and cannot be updated").when(core)
);
List<AvailablePlugin> plugins = collectPluginsToInstall(name);
List<PendingPluginInstallation> pendingInstallations = new ArrayList<>();
for (AvailablePlugin plugin : plugins) {
@@ -171,22 +187,18 @@ public class DefaultPluginManager implements PluginManager {
private List<AvailablePlugin> collectPluginsToInstall(String name) {
List<AvailablePlugin> plugins = new ArrayList<>();
collectPluginsToInstall(plugins, name);
collectPluginsToInstall(plugins, name, true);
return plugins;
}
private boolean isInstalledOrPending(String name) {
return getInstalled(name).isPresent() || getPending(name).isPresent();
}
private void collectPluginsToInstall(List<AvailablePlugin> plugins, String name) {
if (!isInstalledOrPending(name)) {
private void collectPluginsToInstall(List<AvailablePlugin> plugins, String name, boolean isUpdate) {
if (!isInstalledOrPending(name) || isUpdate && isUpdatable(name)) {
AvailablePlugin plugin = getAvailable(name).orElseThrow(() -> NotFoundException.notFound(entity(AvailablePlugin.class, name)));
Set<String> dependencies = plugin.getDescriptor().getDependencies();
if (dependencies != null) {
for (String dependency: dependencies){
collectPluginsToInstall(plugins, dependency);
collectPluginsToInstall(plugins, dependency, false);
}
}
@@ -195,4 +207,12 @@ public class DefaultPluginManager implements PluginManager {
LOG.info("plugin {} is already installed or installation is pending, skipping installation", name);
}
}
private boolean isInstalledOrPending(String name) {
return getInstalled(name).isPresent() || getPending(name).isPresent();
}
private boolean isUpdatable(String name) {
return getAvailable(name).isPresent() && !getPending(name).isPresent();
}
}

4
scm-webapp/src/main/java/sonia/scm/plugin/PluginCenterLoader.java
View File

@@ -33,8 +33,8 @@ class PluginCenterLoader {
LOG.info("fetch plugins from {}", url);
PluginCenterDto pluginCenterDto = client.get(url).request().contentFromJson(PluginCenterDto.class);
return mapper.map(pluginCenterDto);
} catch (IOException ex) {
LOG.error("failed to load plugins from plugin center, returning empty list");
} catch (Exception ex) {
LOG.error("failed to load plugins from plugin center, returning empty list", ex);
return Collections.emptySet();
}
}

5
scm-webapp/src/main/java/sonia/scm/plugin/PluginProcessor.java
View File

@@ -461,13 +461,16 @@ public final class PluginProcessor
Path descriptorPath = directory.resolve(PluginConstants.FILE_DESCRIPTOR);
if (Files.exists(descriptorPath)) {
boolean core = Files.exists(directory.resolve("core"));
ClassLoader cl = createClassLoader(classLoader, smp);
InstalledPluginDescriptor descriptor = createDescriptor(cl, descriptorPath);
WebResourceLoader resourceLoader = createWebResourceLoader(directory);
plugin = new InstalledPlugin(descriptor, cl, resourceLoader, directory);
plugin = new InstalledPlugin(descriptor, cl, resourceLoader, directory, core);
} else {
logger.warn("found plugin directory without plugin descriptor");
}

85
scm-webapp/src/test/java/sonia/scm/api/v2/resources/AvailablePluginResourceTest.java
View File

@@ -1,6 +1,7 @@
package sonia.scm.api.v2.resources;
import de.otto.edison.hal.HalRepresentation;
import org.apache.shiro.ShiroException;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.ThreadContext;
import org.jboss.resteasy.core.Dispatcher;
@@ -18,6 +19,8 @@ import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.AvailablePluginDescriptor;
import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.InstalledPluginDescriptor;
import sonia.scm.plugin.PluginCondition;
import sonia.scm.plugin.PluginInformation;
import sonia.scm.plugin.PluginManager;
@@ -25,7 +28,6 @@ import sonia.scm.web.VndMediaType;
import javax.inject.Provider;
import javax.servlet.http.HttpServletResponse;
import java.io.UnsupportedEncodingException;
import java.net.URISyntaxException;
import java.util.Collections;
@@ -34,6 +36,9 @@ import java.util.Optional;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
@@ -43,9 +48,6 @@ class AvailablePluginResourceTest {
private Dispatcher dispatcher;
@Mock
Provider<InstalledPluginResource> installedPluginResourceProvider;
@Mock
Provider<AvailablePluginResource> availablePluginResourceProvider;
@@ -63,13 +65,14 @@ class AvailablePluginResourceTest {
PluginRootResource pluginRootResource;
private final Subject subject = mock(Subject.class);
@Mock
Subject subject;
@BeforeEach
void prepareEnvironment() {
dispatcher = MockDispatcherFactory.createDispatcher();
pluginRootResource = new PluginRootResource(installedPluginResourceProvider, availablePluginResourceProvider);
pluginRootResource = new PluginRootResource(null, availablePluginResourceProvider, null);
when(availablePluginResourceProvider.get()).thenReturn(availablePluginResource);
dispatcher.getRegistry().addSingletonResource(pluginRootResource);
}
@@ -80,7 +83,7 @@ class AvailablePluginResourceTest {
@BeforeEach
void bindSubject() {
ThreadContext.bind(subject);
when(subject.isPermitted(any(String.class))).thenReturn(true);
doNothing().when(subject).checkPermission(any(String.class));
}
@AfterEach
@@ -90,9 +93,10 @@ class AvailablePluginResourceTest {
@Test
void getAvailablePlugins() throws URISyntaxException, UnsupportedEncodingException {
AvailablePlugin plugin = createPlugin();
AvailablePlugin plugin = createAvailablePlugin();
when(pluginManager.getAvailable()).thenReturn(Collections.singletonList(plugin));
when(pluginManager.getInstalled()).thenReturn(Collections.emptyList());
when(collectionMapper.mapAvailable(Collections.singletonList(plugin))).thenReturn(new MockedResultDto());
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/available");
@@ -105,13 +109,32 @@ class AvailablePluginResourceTest {
assertThat(response.getContentAsString()).contains("\"marker\":\"x\"");
}
@Test
void shouldNotReturnInstalledPlugins() throws URISyntaxException, UnsupportedEncodingException {
AvailablePlugin availablePlugin = createAvailablePlugin();
InstalledPlugin installedPlugin = createInstalledPlugin();
when(pluginManager.getAvailable()).thenReturn(Collections.singletonList(availablePlugin));
when(pluginManager.getInstalled()).thenReturn(Collections.singletonList(installedPlugin));
lenient().when(collectionMapper.mapAvailable(Collections.singletonList(availablePlugin))).thenReturn(new MockedResultDto());
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/available");
request.accept(VndMediaType.PLUGIN_COLLECTION);
MockHttpResponse response = new MockHttpResponse();
dispatcher.invoke(request, response);
assertThat(HttpServletResponse.SC_OK).isEqualTo(response.getStatus());
assertThat(response.getContentAsString()).doesNotContain("\"marker\":\"x\"");
}
@Test
void getAvailablePlugin() throws UnsupportedEncodingException, URISyntaxException {
PluginInformation pluginInformation = new PluginInformation();
pluginInformation.setName("pluginName");
pluginInformation.setVersion("2.0.0");
AvailablePlugin plugin = createPlugin(pluginInformation);
AvailablePlugin plugin = createAvailablePlugin(pluginInformation);
when(pluginManager.getAvailable("pluginName")).thenReturn(Optional.of(plugin));
@@ -139,38 +162,46 @@ class AvailablePluginResourceTest {
verify(pluginManager).install("pluginName", false);
assertThat(HttpServletResponse.SC_OK).isEqualTo(response.getStatus());
}
@Test
void installPendingPlugin() throws URISyntaxException {
MockHttpRequest request = MockHttpRequest.post("/v2/plugins/available/install-pending");
MockHttpResponse response = new MockHttpResponse();
dispatcher.invoke(request, response);
verify(pluginManager).installPendingAndRestart();
assertThat(HttpServletResponse.SC_OK).isEqualTo(response.getStatus());
}
}
private AvailablePlugin createPlugin() {
return createPlugin(new PluginInformation());
private AvailablePlugin createAvailablePlugin() {
PluginInformation pluginInformation = new PluginInformation();
pluginInformation.setName("scm-some-plugin");
return createAvailablePlugin(pluginInformation);
}
private AvailablePlugin createPlugin(PluginInformation pluginInformation) {
private AvailablePlugin createAvailablePlugin(PluginInformation pluginInformation) {
AvailablePluginDescriptor descriptor = new AvailablePluginDescriptor(
pluginInformation, new PluginCondition(), Collections.emptySet(), "https://download.hitchhiker.com", null
);
return new AvailablePlugin(descriptor);
}
private InstalledPlugin createInstalledPlugin() {
PluginInformation pluginInformation = new PluginInformation();
pluginInformation.setName("scm-some-plugin");
return createInstalledPlugin(pluginInformation);
}
private InstalledPlugin createInstalledPlugin(PluginInformation pluginInformation) {
InstalledPluginDescriptor descriptor = mock(InstalledPluginDescriptor.class);
lenient().when(descriptor.getInformation()).thenReturn(pluginInformation);
return new InstalledPlugin(descriptor, null, null, null, false);
}
@Nested
class WithoutAuthorization {
@BeforeEach
void unbindSubject() {
ThreadContext.unbindSubject();
void bindSubject() {
ThreadContext.bind(subject);
doThrow(new ShiroException()).when(subject).checkPermission(any(String.class));
}
@AfterEach
public void unbindSubject() {
ThreadContext.unbindSubject();
}
@Test
void shouldNotGetAvailablePluginsIfMissingPermission() throws URISyntaxException {
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/available");
@@ -178,6 +209,7 @@ class AvailablePluginResourceTest {
MockHttpResponse response = new MockHttpResponse();
assertThrows(UnhandledException.class, () -> dispatcher.invoke(request, response));
verify(subject).checkPermission(any(String.class));
}
@Test
@@ -187,16 +219,17 @@ class AvailablePluginResourceTest {
MockHttpResponse response = new MockHttpResponse();
assertThrows(UnhandledException.class, () -> dispatcher.invoke(request, response));
verify(subject).checkPermission(any(String.class));
}
@Test
void shouldNotInstallPluginIfMissingPermission() throws URISyntaxException {
ThreadContext.unbindSubject();
MockHttpRequest request = MockHttpRequest.post("/v2/plugins/available/pluginName/install");
request.accept(VndMediaType.PLUGIN);
MockHttpResponse response = new MockHttpResponse();
assertThrows(UnhandledException.class, () -> dispatcher.invoke(request, response));
verify(subject).checkPermission(any(String.class));
}
}

7
scm-webapp/src/test/java/sonia/scm/api/v2/resources/InstalledPluginResourceTest.java
View File

@@ -29,6 +29,7 @@ import java.net.URISyntaxException;
import java.util.Collections;
import java.util.Optional;
import static java.util.Collections.emptyList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
@@ -65,7 +66,7 @@ class InstalledPluginResourceTest {
@BeforeEach
void prepareEnvironment() {
dispatcher = MockDispatcherFactory.createDispatcher();
pluginRootResource = new PluginRootResource(installedPluginResourceProvider, availablePluginResourceProvider);
pluginRootResource = new PluginRootResource(installedPluginResourceProvider, null, null);
when(installedPluginResourceProvider.get()).thenReturn(installedPluginResource);
dispatcher.getRegistry().addSingletonResource(pluginRootResource);
}
@@ -88,7 +89,7 @@ class InstalledPluginResourceTest {
void getInstalledPlugins() throws URISyntaxException, UnsupportedEncodingException {
InstalledPlugin installedPlugin = createInstalled("");
when(pluginManager.getInstalled()).thenReturn(Collections.singletonList(installedPlugin));
when(collectionMapper.mapInstalled(Collections.singletonList(installedPlugin))).thenReturn(new MockedResultDto());
when(collectionMapper.mapInstalled(Collections.singletonList(installedPlugin), Collections.emptyList())).thenReturn(new MockedResultDto());
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/installed");
request.accept(VndMediaType.PLUGIN_COLLECTION);
@@ -111,7 +112,7 @@ class InstalledPluginResourceTest {
PluginDto pluginDto = new PluginDto();
pluginDto.setName("pluginName");
when(mapper.mapInstalled(installedPlugin)).thenReturn(pluginDto);
when(mapper.mapInstalled(installedPlugin, emptyList())).thenReturn(pluginDto);
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/installed/pluginName");
request.accept(VndMediaType.PLUGIN);

227
scm-webapp/src/test/java/sonia/scm/api/v2/resources/PendingPluginResourceTest.java Normal file
View File

@@ -0,0 +1,227 @@
package sonia.scm.api.v2.resources;
import com.google.inject.util.Providers;
import org.apache.shiro.ShiroException;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.ThreadContext;
import org.jboss.resteasy.core.Dispatcher;
import org.jboss.resteasy.mock.MockDispatcherFactory;
import org.jboss.resteasy.mock.MockHttpRequest;
import org.jboss.resteasy.mock.MockHttpResponse;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.AvailablePluginDescriptor;
import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.InstalledPluginDescriptor;
import sonia.scm.plugin.PluginInformation;
import sonia.scm.plugin.PluginManager;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import java.io.UnsupportedEncodingException;
import java.net.URISyntaxException;
import static java.net.URI.create;
import static java.util.Collections.singletonList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
@ExtendWith(MockitoExtension.class)
class PendingPluginResourceTest {
Dispatcher dispatcher = MockDispatcherFactory.createDispatcher();
ResourceLinks resourceLinks = ResourceLinksMock.createMock(create("/"));
@Mock
PluginManager pluginManager;
@Mock
PluginDtoMapper mapper;
@Mock
Subject subject;
@InjectMocks
PendingPluginResource pendingPluginResource;
MockHttpResponse response = new MockHttpResponse();
@BeforeEach
void prepareEnvironment() {
dispatcher = MockDispatcherFactory.createDispatcher();
dispatcher.getProviderFactory().register(new PermissionExceptionMapper());
PluginRootResource pluginRootResource = new PluginRootResource(null, null, Providers.of(pendingPluginResource));
dispatcher.getRegistry().addSingletonResource(pluginRootResource);
}
@BeforeEach
void mockMapper() {
lenient().when(mapper.mapAvailable(any())).thenAnswer(invocation -> {
PluginDto dto = new PluginDto();
dto.setName(((AvailablePlugin)invocation.getArgument(0)).getDescriptor().getInformation().getName());
return dto;
});
lenient().when(mapper.mapInstalled(any(), any())).thenAnswer(invocation -> {
PluginDto dto = new PluginDto();
dto.setName(((InstalledPlugin)invocation.getArgument(0)).getDescriptor().getInformation().getName());
return dto;
});
}
@Nested
class withAuthorization {
@BeforeEach
void bindSubject() {
ThreadContext.bind(subject);
doNothing().when(subject).checkPermission("plugin:manage");
}
@AfterEach
void unbindSubject() {
ThreadContext.unbindSubject();
}
@Test
void shouldGetEmptyPluginListsWithoutInstallLinkWhenNoPendingPluginsPresent() throws URISyntaxException, UnsupportedEncodingException {
AvailablePlugin availablePlugin = createAvailablePlugin("not-pending-plugin");
when(availablePlugin.isPending()).thenReturn(false);
when(pluginManager.getAvailable()).thenReturn(singletonList(availablePlugin));
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/pending");
dispatcher.invoke(request, response);
assertThat(response.getStatus()).isEqualTo(HttpServletResponse.SC_OK);
assertThat(response.getContentAsString()).contains("\"_links\":{\"self\":{\"href\":\"/v2/plugins/pending\"}}");
assertThat(response.getContentAsString()).doesNotContain("not-pending-plugin");
}
@Test
void shouldGetPendingAvailablePluginListWithInstallLink() throws URISyntaxException, UnsupportedEncodingException {
AvailablePlugin availablePlugin = createAvailablePlugin("pending-available-plugin");
when(availablePlugin.isPending()).thenReturn(true);
when(pluginManager.getAvailable()).thenReturn(singletonList(availablePlugin));
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/pending");
dispatcher.invoke(request, response);
assertThat(response.getStatus()).isEqualTo(HttpServletResponse.SC_OK);
assertThat(response.getContentAsString()).contains("\"new\":[{\"name\":\"pending-available-plugin\"");
assertThat(response.getContentAsString()).contains("\"execute\":{\"href\":\"/v2/plugins/pending/install\"}");
System.out.println(response.getContentAsString());
}
@Test
void shouldGetPendingUpdatePluginListWithInstallLink() throws URISyntaxException, UnsupportedEncodingException {
AvailablePlugin availablePlugin = createAvailablePlugin("available-plugin");
when(availablePlugin.isPending()).thenReturn(true);
when(pluginManager.getAvailable()).thenReturn(singletonList(availablePlugin));
InstalledPlugin installedPlugin = createInstalledPlugin("available-plugin");
when(pluginManager.getInstalled()).thenReturn(singletonList(installedPlugin));
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/pending");
dispatcher.invoke(request, response);
assertThat(response.getStatus()).isEqualTo(HttpServletResponse.SC_OK);
assertThat(response.getContentAsString()).contains("\"update\":[{\"name\":\"available-plugin\"");
assertThat(response.getContentAsString()).contains("\"execute\":{\"href\":\"/v2/plugins/pending/install\"}");
System.out.println(response.getContentAsString());
}
@Test
void shouldInstallPendingPlugins() throws URISyntaxException {
MockHttpRequest request = MockHttpRequest.post("/v2/plugins/pending/install");
dispatcher.invoke(request, response);
assertThat(response.getStatus()).isEqualTo(HttpServletResponse.SC_OK);
verify(pluginManager).installPendingAndRestart();
}
}
@Nested
class WithoutAuthorization {
@BeforeEach
void bindSubject() {
ThreadContext.bind(subject);
doThrow(new ShiroException()).when(subject).checkPermission("plugin:manage");
}
@AfterEach
void unbindSubject() {
ThreadContext.unbindSubject();
}
@Test
void shouldNotListPendingPlugins() throws URISyntaxException {
MockHttpRequest request = MockHttpRequest.get("/v2/plugins/pending");
dispatcher.invoke(request, response);
assertThat(response.getStatus()).isEqualTo(HttpServletResponse.SC_UNAUTHORIZED);
verify(pluginManager, never()).installPendingAndRestart();
}
@Test
void shouldNotInstallPendingPlugins() throws URISyntaxException {
MockHttpRequest request = MockHttpRequest.post("/v2/plugins/pending/install");
dispatcher.invoke(request, response);
assertThat(response.getStatus()).isEqualTo(HttpServletResponse.SC_UNAUTHORIZED);
verify(pluginManager, never()).installPendingAndRestart();
}
}
static class PermissionExceptionMapper implements ExceptionMapper<ShiroException> {
@Override
public Response toResponse(ShiroException exception) {
return Response.status(401).entity(exception.getMessage()).build();
}
}
private AvailablePlugin createAvailablePlugin(String name) {
PluginInformation pluginInformation = new PluginInformation();
pluginInformation.setName(name);
return createAvailablePlugin(pluginInformation);
}
private AvailablePlugin createAvailablePlugin(PluginInformation pluginInformation) {
AvailablePluginDescriptor descriptor = mock(AvailablePluginDescriptor.class);
lenient().when(descriptor.getInformation()).thenReturn(pluginInformation);
AvailablePlugin availablePlugin = mock(AvailablePlugin.class);
lenient().when(availablePlugin.getDescriptor()).thenReturn(descriptor);
return availablePlugin;
}
private InstalledPlugin createInstalledPlugin(String name) {
PluginInformation pluginInformation = new PluginInformation();
pluginInformation.setName(name);
return createInstalledPlugin(pluginInformation);
}
private InstalledPlugin createInstalledPlugin(PluginInformation pluginInformation) {
InstalledPluginDescriptor descriptor = mock(InstalledPluginDescriptor.class);
lenient().when(descriptor.getInformation()).thenReturn(pluginInformation);
InstalledPlugin installedPlugin = mock(InstalledPlugin.class);
lenient().when(installedPlugin.getDescriptor()).thenReturn(descriptor);
return installedPlugin;
}
}

171
scm-webapp/src/test/java/sonia/scm/api/v2/resources/PluginDtoCollectionMapperTest.java Normal file
View File

@@ -0,0 +1,171 @@
package sonia.scm.api.v2.resources;
import de.otto.edison.hal.HalRepresentation;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.subject.support.SubjectThreadState;
import org.apache.shiro.util.ThreadContext;
import org.apache.shiro.util.ThreadState;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.junit.jupiter.MockitoExtension;
import sonia.scm.plugin.AvailablePlugin;
import sonia.scm.plugin.AvailablePluginDescriptor;
import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.InstalledPluginDescriptor;
import sonia.scm.plugin.PluginInformation;
import java.net.URI;
import java.util.List;
import static java.util.Collections.singletonList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
@ExtendWith(MockitoExtension.class)
class PluginDtoCollectionMapperTest {
ResourceLinks resourceLinks = ResourceLinksMock.createMock(URI.create("/"));
@InjectMocks
PluginDtoMapperImpl pluginDtoMapper;
Subject subject = mock(Subject.class);
ThreadState subjectThreadState = new SubjectThreadState(subject);
@BeforeEach
void bindSubject() {
subjectThreadState.bind();
ThreadContext.bind(subject);
}
@AfterEach
public void unbindSubject() {
ThreadContext.unbindSubject();
}
@Test
void shouldMapInstalledPluginsWithoutUpdateWhenNoNewerVersionIsAvailable() {
PluginDtoCollectionMapper mapper = new PluginDtoCollectionMapper(resourceLinks, pluginDtoMapper);
HalRepresentation result = mapper.mapInstalled(
singletonList(createInstalledPlugin("scm-some-plugin", "1")),
singletonList(createAvailablePlugin("scm-other-plugin", "2")));
List<HalRepresentation> plugins = result.getEmbedded().getItemsBy("plugins");
assertThat(plugins).hasSize(1);
PluginDto plugin = (PluginDto) plugins.get(0);
assertThat(plugin.getVersion()).isEqualTo("1");
assertThat(plugin.getNewVersion()).isNull();
}
@Test
void shouldSetNewVersionInInstalledPluginWhenAvailableVersionIsNewer() {
PluginDtoCollectionMapper mapper = new PluginDtoCollectionMapper(resourceLinks, pluginDtoMapper);
HalRepresentation result = mapper.mapInstalled(
singletonList(createInstalledPlugin("scm-some-plugin", "1")),
singletonList(createAvailablePlugin("scm-some-plugin", "2")));
PluginDto plugin = getPluginDtoFromResult(result);
assertThat(plugin.getVersion()).isEqualTo("1");
assertThat(plugin.getNewVersion()).isEqualTo("2");
}
@Test
void shouldNotAddInstallLinkForNewVersionWhenNotPermitted() {
when(subject.isPermitted("plugin:manage")).thenReturn(false);
PluginDtoCollectionMapper mapper = new PluginDtoCollectionMapper(resourceLinks, pluginDtoMapper);
HalRepresentation result = mapper.mapInstalled(
singletonList(createInstalledPlugin("scm-some-plugin", "1")),
singletonList(createAvailablePlugin("scm-some-plugin", "2")));
PluginDto plugin = getPluginDtoFromResult(result);
assertThat(plugin.getLinks().getLinkBy("update")).isEmpty();
}
@Test
void shouldNotAddInstallLinkForNewVersionWhenInstallationIsPending() {
when(subject.isPermitted("plugin:manage")).thenReturn(true);
PluginDtoCollectionMapper mapper = new PluginDtoCollectionMapper(resourceLinks, pluginDtoMapper);
AvailablePlugin availablePlugin = createAvailablePlugin("scm-some-plugin", "2");
when(availablePlugin.isPending()).thenReturn(true);
HalRepresentation result = mapper.mapInstalled(
singletonList(createInstalledPlugin("scm-some-plugin", "1")),
singletonList(availablePlugin));
PluginDto plugin = getPluginDtoFromResult(result);
assertThat(plugin.getLinks().getLinkBy("update")).isEmpty();
}
@Test
void shouldAddInstallLinkForNewVersionWhenPermitted() {
when(subject.isPermitted("plugin:manage")).thenReturn(true);
PluginDtoCollectionMapper mapper = new PluginDtoCollectionMapper(resourceLinks, pluginDtoMapper);
HalRepresentation result = mapper.mapInstalled(
singletonList(createInstalledPlugin("scm-some-plugin", "1")),
singletonList(createAvailablePlugin("scm-some-plugin", "2")));
PluginDto plugin = getPluginDtoFromResult(result);
assertThat(plugin.getLinks().getLinkBy("update")).isNotEmpty();
}
@Test
void shouldSetInstalledPluginPendingWhenCorrespondingAvailablePluginIsPending() {
when(subject.isPermitted("plugin:manage")).thenReturn(true);
PluginDtoCollectionMapper mapper = new PluginDtoCollectionMapper(resourceLinks, pluginDtoMapper);
AvailablePlugin availablePlugin = createAvailablePlugin("scm-some-plugin", "2");
when(availablePlugin.isPending()).thenReturn(true);
HalRepresentation result = mapper.mapInstalled(
singletonList(createInstalledPlugin("scm-some-plugin", "1")),
singletonList(availablePlugin));
PluginDto plugin = getPluginDtoFromResult(result);
assertThat(plugin.isPending()).isTrue();
}
private PluginDto getPluginDtoFromResult(HalRepresentation result) {
assertThat(result.getEmbedded().getItemsBy("plugins")).hasSize(1);
List<HalRepresentation> plugins = result.getEmbedded().getItemsBy("plugins");
return (PluginDto) plugins.get(0);
}
private InstalledPlugin createInstalledPlugin(String name, String version) {
PluginInformation information = new PluginInformation();
information.setName(name);
information.setVersion(version);
return createInstalledPlugin(information);
}
private InstalledPlugin createInstalledPlugin(PluginInformation information) {
InstalledPlugin plugin = mock(InstalledPlugin.class);
InstalledPluginDescriptor descriptor = mock(InstalledPluginDescriptor.class);
lenient().when(descriptor.getInformation()).thenReturn(information);
lenient().when(plugin.getDescriptor()).thenReturn(descriptor);
return plugin;
}
private AvailablePlugin createAvailablePlugin(String name, String version) {
PluginInformation information = new PluginInformation();
information.setName(name);
information.setVersion(version);
return createAvailablePlugin(information);
}
private AvailablePlugin createAvailablePlugin(PluginInformation information) {
AvailablePlugin plugin = mock(AvailablePlugin.class);
AvailablePluginDescriptor descriptor = mock(AvailablePluginDescriptor.class);
lenient().when(descriptor.getInformation()).thenReturn(information);
lenient().when(plugin.getDescriptor()).thenReturn(descriptor);
return plugin;
}
}

4
scm-webapp/src/test/java/sonia/scm/api/v2/resources/PluginDtoMapperTest.java
View File

@@ -17,7 +17,9 @@ import sonia.scm.plugin.InstalledPlugin;
import sonia.scm.plugin.PluginInformation;
import java.net.URI;
import java.util.Collections;
import static java.util.Collections.emptyList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
@@ -76,7 +78,7 @@ class PluginDtoMapperTest {
void shouldAppendInstalledSelfLink() {
InstalledPlugin plugin = createInstalled(createPluginInformation());
PluginDto dto = mapper.mapInstalled(plugin);
PluginDto dto = mapper.mapInstalled(plugin, emptyList());
assertThat(dto.getLinks().getLinkBy("self").get().getHref())
.isEqualTo("https://hitchhiker.com/v2/plugins/installed/scm-cas-plugin");
}

1
scm-webapp/src/test/java/sonia/scm/api/v2/resources/ResourceLinksMock.java
View File

@@ -38,6 +38,7 @@ public class ResourceLinksMock {
when(resourceLinks.repositoryTypeCollection()).thenReturn(new ResourceLinks.RepositoryTypeCollectionLinks(uriInfo));
when(resourceLinks.installedPluginCollection()).thenReturn(new ResourceLinks.InstalledPluginCollectionLinks(uriInfo));
when(resourceLinks.availablePluginCollection()).thenReturn(new ResourceLinks.AvailablePluginCollectionLinks(uriInfo));
when(resourceLinks.pendingPluginCollection()).thenReturn(new ResourceLinks.PendingPluginCollectionLinks(uriInfo));
when(resourceLinks.installedPlugin()).thenReturn(new ResourceLinks.InstalledPluginLinks(uriInfo));
when(resourceLinks.availablePlugin()).thenReturn(new ResourceLinks.AvailablePluginLinks(uriInfo));
when(resourceLinks.uiPluginCollection()).thenReturn(new ResourceLinks.UIPluginCollectionLinks(uriInfo));

2
scm-webapp/src/test/java/sonia/scm/plugin/DefaultUberWebResourceLoaderTest.java
View File

@@ -248,7 +248,7 @@ public class DefaultUberWebResourceLoaderTest extends WebResourceLoaderTestBase
private InstalledPlugin createPluginWrapper(Path directory)
{
return new InstalledPlugin(null, null, new PathWebResourceLoader(directory),
directory);
directory, false);
}
//~--- fields ---------------------------------------------------------------

2
scm-webapp/src/test/java/sonia/scm/plugin/PluginTestHelper.java
View File

@@ -10,12 +10,14 @@ public class PluginTestHelper {
public static AvailablePlugin createAvailable(String name) {
PluginInformation information = new PluginInformation();
information.setName(name);
information.setVersion("1.0");
return createAvailable(information);
}
public static InstalledPlugin createInstalled(String name) {
PluginInformation information = new PluginInformation();
information.setName(name);
information.setVersion("1.0");
return createInstalled(information);
}