paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

Merge pull request #30173 from mbenson/templating_fn_metadata_absent_message

Browse Source 
display appropriate message when global templating function metadata …
This commit is contained in:
Ben Lambert
2025-06-09 09:52:03 +02:00
committed by GitHub
parent 0f80429df5 95a1d722f9
commit 296db2bbb9
5 changed files with 107 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/purple-times-deny.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder': patch
---
Added appropriate message when global templating function metadata is absent.
plugins/scaffolder/report-alpha.api.md
+1
View File
@@ -430,6 +430,7 @@ export const scaffolderTranslationRef: TranslationRef<
readonly 'templatingExtensions.content.functions.schema.arguments': 'Arguments';
readonly 'templatingExtensions.content.functions.examples': 'Examples';
readonly 'templatingExtensions.content.functions.notAvailable': 'There are no global template functions defined.';
readonly 'templatingExtensions.content.functions.metadataAbsent': 'Function metadata unavailable';
readonly 'templatingExtensions.title': 'Templating Extensions';
readonly 'templatingExtensions.subtitle': 'This is the collection of available templating extensions';
readonly 'templatingExtensions.pageTitle': 'Templating Extensions';
plugins/scaffolder/src/components/TemplatingExtensionsPage/TemplateGlobals.tsx
+5 -2
View File
@@ -48,8 +48,11 @@ const FunctionDetailContent = ({
const expanded = useState<Expanded>({});
if (!Object.keys(fn).length) {
return (
<Typography style={{ fontStyle: 'italic' }}>
{t('templatingExtensions.content.functions.notAvailable')}
<Typography
style={{ fontStyle: 'italic' }}
data-testid={`${name}.metadataAbsent`}
>
{t('templatingExtensions.content.functions.metadataAbsent')}
</Typography>
);
}
plugins/scaffolder/src/components/TemplatingExtensionsPage/TemplatingExtensionsPage.test.tsx
+95 -59
View File
@@ -315,76 +315,112 @@ describe('TemplatingExtensionsPage', () => {
});
});
describe('renders global', () => {
it('renders global functions', async () => {
listTemplatingExtensions.mockResolvedValue({
...emptyExtensions,
globals: {
...emptyExtensions.globals,
functions: {
truthy: {
description: 'evaluate truthiness',
schema: {
arguments: [
{
title: 'input',
},
],
output: {
type: 'boolean',
},
},
examples: [
{
description: 'basic usage',
example: "truthy('foo')",
notes: 'yields `true`',
},
],
describe('renders global functions', () => {
it('without metadata', async () => {
listTemplatingExtensions.mockResolvedValue({
...emptyExtensions,
globals: {
...emptyExtensions.globals,
functions: {
anything: {},
},
},
},
});
const { findByTestId, getByRole } = await r();
fireEvent.click(within(getByRole('tablist')).getByText('Functions'));
const functions = await findByTestId('functions');
const anything = within(functions).getByTestId('anything');
const title = within(anything).getByText('anything');
expect(title).toBeInTheDocument();
expect(title.id).toBe('function_anything');
const link = within(anything).getByRole('link');
expect(link).toBeInTheDocument();
expect(link).toHaveAttribute(
'href',
expect.stringMatching(new RegExp(`#${title.id}$`)),
);
expect(
within(anything).getByTestId('anything.metadataAbsent'),
).toBeInTheDocument();
});
const { findByTestId, getByRole } = await r();
it('with metadata', async () => {
listTemplatingExtensions.mockResolvedValue({
...emptyExtensions,
globals: {
...emptyExtensions.globals,
functions: {
truthy: {
description: 'evaluate truthiness',
schema: {
arguments: [
{
title: 'input',
},
],
output: {
type: 'boolean',
},
},
examples: [
{
description: 'basic usage',
example: "truthy('foo')",
notes: 'yields `true`',
},
],
},
},
},
});
const { findByTestId, getByRole } = await r();
fireEvent.click(within(getByRole('tablist')).getByText('Functions'));
fireEvent.click(within(getByRole('tablist')).getByText('Functions'));
const functions = await findByTestId('functions');
const functions = await findByTestId('functions');
const truthy = within(functions).getByTestId('truthy');
const title = within(truthy).getByText('truthy');
expect(title).toBeInTheDocument();
expect(title.id).toBe('function_truthy');
const truthy = within(functions).getByTestId('truthy');
const title = within(truthy).getByText('truthy');
expect(title).toBeInTheDocument();
expect(title.id).toBe('function_truthy');
const link = within(truthy).getByRole('link');
expect(link).toBeInTheDocument();
expect(link).toHaveAttribute(
'href',
expect.stringMatching(new RegExp(`#${title.id}$`)),
);
const link = within(truthy).getByRole('link');
expect(link).toBeInTheDocument();
expect(link).toHaveAttribute(
'href',
expect.stringMatching(new RegExp(`#${title.id}$`)),
);
expect(
within(truthy).queryByTestId('truthy.metadataAbsent'),
).not.toBeInTheDocument();
expect(
within(truthy).getByText('evaluate truthiness'),
).toBeInTheDocument();
expect(
within(truthy).getByText('evaluate truthiness'),
).toBeInTheDocument();
expect(within(truthy).getByText('[0]')).toBeInTheDocument();
expect(
within(truthy).getByTestId('root_truthy.arg0'),
).toBeInTheDocument();
expect(
within(truthy).queryByTestId('root_truthy.arg1'),
).not.toBeInTheDocument();
expect(
within(truthy).getByTestId('root_truthy.output'),
).toBeInTheDocument();
expect(within(truthy).getByText('[0]')).toBeInTheDocument();
expect(
within(truthy).getByTestId('root_truthy.arg0'),
).toBeInTheDocument();
expect(
within(truthy).queryByTestId('root_truthy.arg1'),
).not.toBeInTheDocument();
expect(
within(truthy).getByTestId('root_truthy.output'),
).toBeInTheDocument();
const x = within(truthy).getByTestId('examples');
expect(x).toBeInTheDocument();
const xd0 = within(x).getByTestId('example_desc0');
expect(xd0).toBeInTheDocument();
expect(xd0).toHaveTextContent(/basic usage\s*yields\s*true/);
const x = within(truthy).getByTestId('examples');
expect(x).toBeInTheDocument();
const xd0 = within(x).getByTestId('example_desc0');
expect(xd0).toBeInTheDocument();
expect(xd0).toHaveTextContent(/basic usage\s*yields\s*true/);
const xc0 = within(x).getByTestId('example_code0');
expect(within(xc0).getByText("truthy('foo')")).toBeInTheDocument();
const xc0 = within(x).getByTestId('example_code0');
expect(within(xc0).getByText("truthy('foo')")).toBeInTheDocument();
});
});
it('renders global values', async () => {
const msvValue = ['foo', 'bar', 'baz'];
plugins/scaffolder/src/translation.ts
+1
View File
@@ -226,6 +226,7 @@ export const scaffolderTranslationRef = createTranslationRef({
functions: {
title: 'Functions',
notAvailable: 'There are no global template functions defined.',
metadataAbsent: 'Function metadata unavailable',
schema: {
arguments: 'Arguments',
output: 'Output',