1 package com.atlassian.maven.plugins.amps.codegen.prompter.jira;
2
3 import java.util.Arrays;
4 import java.util.List;
5 import java.util.Map;
6
7 import com.atlassian.core.util.map.EasyMap;
8 import com.atlassian.maven.plugins.amps.codegen.jira.CustomFieldTypeFactory;
9 import com.atlassian.maven.plugins.amps.codegen.prompter.AbstractModulePrompter;
10 import com.atlassian.maven.plugins.amps.codegen.prompter.AbstractPrompterTest;
11 import com.atlassian.maven.plugins.amps.codegen.prompter.PluginModulePrompter;
12 import com.atlassian.plugins.codegen.modules.common.Resource;
13 import com.atlassian.plugins.codegen.modules.jira.CustomFieldProperties;
14
15 import org.apache.commons.lang.StringUtils;
16 import org.codehaus.plexus.components.interactivity.Prompter;
17 import org.codehaus.plexus.components.interactivity.PrompterException;
18 import org.junit.Before;
19 import org.junit.Test;
20
21 import static org.junit.Assert.assertEquals;
22 import static org.junit.Assert.assertTrue;
23 import static org.mockito.Mockito.mock;
24 import static org.mockito.Mockito.when;
25
26
27
28
29 public class CustomFieldPrompterTest extends AbstractPrompterTest
30 {
31 public static final String PACKAGE = "com.atlassian.plugins.jira.customfields";
32 public static final String CLASSNAME = "MyCustomField";
33 public static final String MODULE_NAME = "My Custom Field";
34 public static final String MODULE_KEY = "my-custom-field";
35 public static final String DESCRIPTION = "The My Custom Field Plugin";
36 public static final String I18N_NAME_KEY = "my-custom-field.name";
37 public static final String I18N_DESCRIPTION_KEY = "my-custom-field.description";
38
39 public static final String ADV_MODULE_NAME = "My Awesome Plugin";
40 public static final String ADV_MODULE_KEY = "awesome-module";
41 public static final String ADV_DESCRIPTION = "The Awesomest Plugin Ever";
42 public static final String ADV_I18N_NAME_KEY = "awesome-plugin.name";
43 public static final String ADV_I18N_DESCRIPTION_KEY = "pluginus-awesomeous.description";
44
45 public static final String RESOURCE_NAME = "view";
46 public static final String RESOURCE_VM_PATH = "templates/resource.vm";
47
48 Prompter prompter;
49 TestingCustomFieldTypeFactory fieldTypeFactory;
50
51 @Before
52 public void setup()
53 {
54 prompter = mock(Prompter.class);
55 fieldTypeFactory = new TestingCustomFieldTypeFactory();
56 fieldTypeFactory.setFieldTypes(EasyMap.build("AbstractCustomField", "com.example.AbstractCustomField", "AnotherCustomField", "com.example.AnotherCustomField"));
57 }
58
59 @Test
60 public void basicPropertiesAreValid() throws PrompterException
61 {
62 when(prompter.prompt("Enter New Classname", "MyCustomField")).thenReturn(CLASSNAME);
63 when(prompter.prompt("Enter Package Name", AbstractModulePrompter.DEFAULT_BASE_PACKAGE + ".jira.customfields")).thenReturn(PACKAGE);
64 when(prompter.prompt("Show Advanced Setup?", PluginModulePrompter.YN_ANSWERS, "N")).thenReturn("N");
65 when(prompter.prompt("Include Example Code?", PluginModulePrompter.YN_ANSWERS, "N")).thenReturn("N");
66
67 CustomFieldPrompter modulePrompter = new CustomFieldPrompter(prompter);
68 modulePrompter.setUseAnsiColor(false);
69 CustomFieldProperties props = modulePrompter.getModulePropertiesFromInput(moduleLocation);
70
71 assertEquals("wrong class", CLASSNAME, props.getClassname());
72 assertEquals("wrong class package", PACKAGE, props.getPackage());
73 assertEquals("wrong module name", MODULE_NAME, props.getModuleName());
74 assertEquals("wrong module key", MODULE_KEY, props.getModuleKey());
75 assertEquals("wrong description", DESCRIPTION, props.getDescription());
76 assertEquals("wrong i18n name key", I18N_NAME_KEY, props.getNameI18nKey());
77 assertEquals("wrong i18n desc key", I18N_DESCRIPTION_KEY, props.getDescriptionI18nKey());
78 }
79
80 @Test
81 public void advancedPropertiesAreValid() throws PrompterException
82 {
83 when(prompter.prompt("Enter New Classname", "MyCustomField")).thenReturn(CLASSNAME);
84 when(prompter.prompt("Enter Package Name", AbstractModulePrompter.DEFAULT_BASE_PACKAGE + ".jira.customfields")).thenReturn(PACKAGE);
85 when(prompter.prompt("Show Advanced Setup?", PluginModulePrompter.YN_ANSWERS, "N")).thenReturn("Y");
86
87 when(prompter.prompt("Plugin Name", MODULE_NAME)).thenReturn(ADV_MODULE_NAME);
88 when(prompter.prompt("Plugin Key", MODULE_KEY)).thenReturn(ADV_MODULE_KEY);
89 when(prompter.prompt("Plugin Description", DESCRIPTION)).thenReturn(ADV_DESCRIPTION);
90 when(prompter.prompt("i18n Name Key", I18N_NAME_KEY)).thenReturn(ADV_I18N_NAME_KEY);
91 when(prompter.prompt("i18n Description Key", I18N_DESCRIPTION_KEY)).thenReturn(ADV_I18N_DESCRIPTION_KEY);
92
93 when(prompter.prompt("Choose A Custom Field Type To Extend\n1: AbstractCustomField\n2: AnotherCustomField\nChoose a number: ", Arrays.asList("1", "2"), "")).thenReturn("1");
94
95 when(prompter.prompt("Add Resource", PluginModulePrompter.YN_ANSWERS, "N")).thenReturn("Y")
96 .thenReturn("N");
97 when(prompter.prompt("Enter Resource Name")).thenReturn(RESOURCE_NAME)
98 .thenReturn("");
99 when(prompter.prompt("Enter Location (path to resource file)")).thenReturn(RESOURCE_VM_PATH);
100
101 when(prompter.prompt("Include Example Code?", PluginModulePrompter.YN_ANSWERS, "N")).thenReturn("N");
102
103 CustomFieldPrompter modulePrompter = new CustomFieldPrompter(prompter);
104 modulePrompter.setUseAnsiColor(false);
105 CustomFieldProperties props = modulePrompter.getModulePropertiesFromInput(moduleLocation);
106
107 assertEquals("wrong adv class", CLASSNAME, props.getClassname());
108 assertEquals("wrong adv package", PACKAGE, props.getPackage());
109 assertEquals("wrong adv module name", ADV_MODULE_NAME, props.getModuleName());
110 assertEquals("wrong adv module key", ADV_MODULE_KEY, props.getModuleKey());
111 assertEquals("wrong adv description", ADV_DESCRIPTION, props.getDescription());
112 assertEquals("wrong adv i18n name key", ADV_I18N_NAME_KEY, props.getNameI18nKey());
113 assertEquals("wrong adv i18n desc key", ADV_I18N_DESCRIPTION_KEY, props.getDescriptionI18nKey());
114
115
116 List<Resource> resources = props.getResources();
117 assertTrue("resources not found", !resources.isEmpty());
118 assertEquals("wrong number of resources", 1, resources.size());
119
120 Resource viewResource = resources.get(0);
121
122 assertEquals("wrong css resource name", RESOURCE_NAME, viewResource.getName());
123 assertTrue("name pattern found when name is set", StringUtils.isBlank(viewResource.getNamePattern()));
124 assertEquals("wrong resource type", "velocity", viewResource.getType());
125 assertEquals("wrong resource location", RESOURCE_VM_PATH, viewResource.getLocation());
126
127 assertEquals("wrong super class", "com.example.AbstractCustomField", props.getFullyQualifiedClassToExtend());
128 }
129
130 protected class TestingCustomFieldTypeFactory extends CustomFieldTypeFactory
131 {
132 public void setFieldTypes(Map<String, String> types)
133 {
134 fields = types;
135 }
136 }
137 }