fleet/frontend/pages/ManageControlsPage/Scripts/components/EditScriptModal/EditScriptModal.tsx
Allen Houchins 150318c87e
Add Python script support for macOS and Linux (#38562)
This commit introduces support for Python (.py) scripts on macOS and
Linux, including validation for Python shebangs and updates to
documentation, UI, error messages, and backend validation logic. It also
updates tests and file upload handling to recognize and properly process
Python scripts alongside existing shell (.sh) and PowerShell (.ps1)
scripts.

<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.

- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes

## Testing

- [ ] Added/updated automated tests
- [ ] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)

- [ ] QA'd all new/changed functionality manually

For unreleased bug fixes in a release candidate, one of:

- [ ] Confirmed that the fix is not expected to adversely impact load
test results
- [ ] Alerted the release DRI if additional load testing is needed

## Database migrations

- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).

## New Fleet configuration settings

- [ ] Setting(s) is/are explicitly excluded from GitOps

If you didn't check the box above, follow this checklist for
GitOps-enabled settings:

- [ ] Verified that the setting is exported via `fleetctl
generate-gitops`
- [ ] Verified the setting is documented in a separate PR to [the GitOps
documentation](https://github.com/fleetdm/fleet/blob/main/docs/Configuration/yaml-files.md#L485)
- [ ] Verified that the setting is cleared on the server if it is not
supplied in a YAML file (or that it is documented as being optional)
- [ ] Verified that any relevant UI is disabled when GitOps mode is
enabled

## fleetd/orbit/Fleet Desktop

- [ ] Verified compatibility with the latest released version of Fleet
(see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/workflows/fleetd-development-and-release-strategy.md))
- [ ] If the change applies to only one platform, confirmed that
`runtime.GOOS` is used as needed to isolate changes
- [ ] Verified that fleetd runs on macOS, Linux and Windows
- [ ] Verified auto-update works from the released version of component
to the new version (see [tools/tuf/test](../tools/tuf/test/README.md))

---------

Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: melpike <79950145+melpike@users.noreply.github.com>
Co-authored-by: jkatz01 <yehonatankatz@gmail.com>
Co-authored-by: Jonathan Katz <44128041+jkatz01@users.noreply.github.com>
2026-03-24 10:01:54 -04:00

252 lines
6.3 KiB
TypeScript

import React, { useContext, useState } from "react";
import { useQuery } from "react-query";
import classnames from "classnames";
import { NotificationContext } from "context/notification";
import { AppContext } from "context/app";
import RunScriptHelpText from "pages/hosts/components/ScriptDetailsModal/RunScriptHelpText";
import scriptAPI from "services/entities/scripts";
import Button from "components/buttons/Button";
import DataError from "components/DataError";
import Editor from "components/Editor";
import Modal from "components/Modal";
import ModalFooter from "components/ModalFooter";
import Spinner from "components/Spinner";
import { ScriptContent } from "interfaces/script";
import { DEFAULT_USE_QUERY_OPTIONS } from "utilities/constants";
import { getErrorMessage } from "../ScriptUploadModal/helpers";
const baseClass = "edit-script-modal";
interface IWarningModal {
onExit: () => void;
onSave: () => void;
scriptName: string;
isSubmitting: boolean;
}
const WarningModal = ({
onExit,
onSave,
scriptName,
isSubmitting,
}: IWarningModal) => {
return (
<Modal
className={`${baseClass}__warning`}
title="Save changes?"
onExit={onExit}
>
<p>
The changes you are making will cancel any pending script runs for{" "}
<b>{scriptName}</b>.<br />
<br />
If this script is currently running on a host, it will complete, but
results won&apos;t appear in Fleet. <br />
<br />
You cannot undo this action.
</p>
<div className="modal-cta-wrap">
<Button
type="button"
onClick={onSave}
className="save-loading"
isLoading={isSubmitting}
>
Save
</Button>
<Button onClick={onExit} variant="inverse">
Cancel
</Button>
</div>
</Modal>
);
};
interface IEditScriptModal {
onExit: () => void;
scriptId: number;
scriptName: string;
}
const validate = (scriptContent: string) => {
if (scriptContent.trim() === "") {
return "Script cannot be empty";
}
return null;
};
const EditScriptModal = ({
scriptId,
scriptName,
onExit,
}: IEditScriptModal) => {
const { renderFlash } = useContext(NotificationContext);
const {
currentTeam,
isGlobalAdmin,
isAnyTeamAdmin,
isGlobalMaintainer,
isAnyTeamMaintainer,
isTeamTechnician,
isGlobalTechnician,
} = useContext(AppContext);
const isTechnician = !!isTeamTechnician || !!isGlobalTechnician;
const canRunScripts = !!(
isGlobalAdmin ||
isAnyTeamAdmin ||
isGlobalMaintainer ||
isAnyTeamMaintainer
);
// Editable script content
const [scriptFormData, setScriptFormData] = useState("");
const [isSubmitting, setIsSubmitting] = useState(false);
const [formError, setFormError] = useState<string | null>(null);
const [showConfirmChanges, setShowConfirmChanges] = useState(false);
const {
data: curScriptContent,
error: isSelectedScriptContentError,
isLoading: isLoadingSelectedScriptContent,
} = useQuery<ScriptContent, Error>(
[scriptId],
() => scriptAPI.downloadScript(scriptId),
{
...DEFAULT_USE_QUERY_OPTIONS,
onSuccess: (curScriptContent_) => {
setScriptFormData(curScriptContent_);
},
}
);
const onChange = (value: string) => {
setScriptFormData(value);
const err = validate(value);
if (!err && !!formError) {
setFormError(validate(value));
}
};
const onBlur = () => {
setFormError(validate(scriptFormData));
};
const onSave = async () => {
const err = validate(scriptFormData);
setFormError(err);
if (err || isSubmitting) {
return;
}
// if contents have changed and not already showing the warning modal
if (curScriptContent !== scriptFormData && !showConfirmChanges) {
setShowConfirmChanges(true);
return;
}
// show warning modal and abort this call
try {
setIsSubmitting(true);
await scriptAPI.updateScript(scriptId, scriptFormData, scriptName);
renderFlash("success", "Successfully saved script.");
onExit();
} catch (e) {
renderFlash("error", getErrorMessage(e));
} finally {
setIsSubmitting(false);
setShowConfirmChanges(false);
}
};
const onSubmit = async (e: React.FormEvent<HTMLFormElement>) => {
e.preventDefault();
onSave();
};
const renderContent = () => {
if (isLoadingSelectedScriptContent) {
return <Spinner />;
}
if (isSelectedScriptContentError) {
return <DataError description="Close this modal and try again." />;
}
// Set editing mode based on the file extension.
let mode = "sh";
if (scriptName.match(/\.ps1$/)) {
mode = "powershell";
} else if (scriptName.match(/\.py$/)) {
mode = "python";
}
return (
<>
<form onSubmit={onSubmit}>
<Editor
mode={mode}
error={formError}
label="Script"
onBlur={onBlur}
onChange={onChange}
value={scriptFormData}
/>
<RunScriptHelpText
className="form-field__help-text"
isTechnician={isTechnician}
canRunScripts={canRunScripts}
teamId={currentTeam?.id}
/>
</form>
{canRunScripts && (
<ModalFooter
primaryButtons={
<>
<Button onClick={onExit} variant="inverse">
Cancel
</Button>
<Button
onClick={onSave}
isLoading={isSubmitting}
disabled={!!formError}
>
Save
</Button>
</>
}
/>
)}
</>
);
};
const classes = classnames(baseClass, {
[`${baseClass}__hide-main`]: !!showConfirmChanges,
});
return (
<>
<Modal
className={classes}
title={scriptName}
width="large"
onExit={onExit}
>
{renderContent()}
</Modal>
{!!showConfirmChanges && (
<WarningModal
onExit={() => setShowConfirmChanges(false)}
onSave={onSave}
scriptName={scriptName}
isSubmitting={isSubmitting}
/>
)}
</>
);
};
export default EditScriptModal;