incompatible-packages-component-spec.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. /** @babel */
  2. import etch from 'etch';
  3. import IncompatiblePackagesComponent from '../lib/incompatible-packages-component';
  4. describe('IncompatiblePackagesComponent', () => {
  5. let packages, etchScheduler;
  6. beforeEach(() => {
  7. etchScheduler = etch.getScheduler();
  8. packages = [
  9. {
  10. name: 'incompatible-1',
  11. isCompatible() {
  12. return false;
  13. },
  14. rebuild: function() {
  15. return new Promise(resolve => (this.resolveRebuild = resolve));
  16. },
  17. getBuildFailureOutput() {
  18. return null;
  19. },
  20. path: '/Users/joe/.atom/packages/incompatible-1',
  21. metadata: {
  22. repository: 'https://github.com/atom/incompatible-1',
  23. version: '1.0.0'
  24. },
  25. incompatibleModules: [
  26. { name: 'x', version: '1.0.0', error: 'Expected version X, got Y' },
  27. { name: 'y', version: '1.0.0', error: 'Expected version X, got Z' }
  28. ]
  29. },
  30. {
  31. name: 'incompatible-2',
  32. isCompatible() {
  33. return false;
  34. },
  35. rebuild() {
  36. return new Promise(resolve => (this.resolveRebuild = resolve));
  37. },
  38. getBuildFailureOutput() {
  39. return null;
  40. },
  41. path: '/Users/joe/.atom/packages/incompatible-2',
  42. metadata: {
  43. repository: 'https://github.com/atom/incompatible-2',
  44. version: '1.0.0'
  45. },
  46. incompatibleModules: [
  47. { name: 'z', version: '1.0.0', error: 'Expected version X, got Y' }
  48. ]
  49. },
  50. {
  51. name: 'compatible',
  52. isCompatible() {
  53. return true;
  54. },
  55. rebuild() {
  56. throw new Error('Should not rebuild a compatible package');
  57. },
  58. getBuildFailureOutput() {
  59. return null;
  60. },
  61. path: '/Users/joe/.atom/packages/b',
  62. metadata: {
  63. repository: 'https://github.com/atom/b',
  64. version: '1.0.0'
  65. },
  66. incompatibleModules: []
  67. }
  68. ];
  69. });
  70. describe('when packages have not finished loading', () => {
  71. it('delays rendering incompatible packages until the end of the tick', () => {
  72. waitsForPromise(async () => {
  73. let component = new IncompatiblePackagesComponent({
  74. getActivePackages: () => [],
  75. getLoadedPackages: () => packages
  76. });
  77. let { element } = component;
  78. expect(
  79. element.querySelectorAll('.incompatible-package').length
  80. ).toEqual(0);
  81. await etchScheduler.getNextUpdatePromise();
  82. expect(
  83. element.querySelectorAll('.incompatible-package').length
  84. ).toBeGreaterThan(0);
  85. });
  86. });
  87. });
  88. describe('when there are no incompatible packages', () => {
  89. it('does not render incompatible packages or the rebuild button', () => {
  90. waitsForPromise(async () => {
  91. expect(packages[2].isCompatible()).toBe(true);
  92. let compatiblePackages = [packages[2]];
  93. let component = new IncompatiblePackagesComponent({
  94. getActivePackages: () => compatiblePackages,
  95. getLoadedPackages: () => compatiblePackages
  96. });
  97. let { element } = component;
  98. await etchScheduler.getNextUpdatePromise();
  99. expect(element.querySelectorAll('.incompatible-package').length).toBe(
  100. 0
  101. );
  102. expect(element.querySelector('button')).toBeNull();
  103. });
  104. });
  105. });
  106. describe('when some packages previously failed to rebuild', () => {
  107. it('renders them with failed build status and error output', () => {
  108. waitsForPromise(async () => {
  109. packages[1].getBuildFailureOutput = function() {
  110. return 'The build failed';
  111. };
  112. let component = new IncompatiblePackagesComponent({
  113. getActivePackages: () => packages,
  114. getLoadedPackages: () => packages
  115. });
  116. let { element } = component;
  117. await etchScheduler.getNextUpdatePromise();
  118. let packageElement = element.querySelector(
  119. '.incompatible-package:nth-child(2)'
  120. );
  121. expect(packageElement.querySelector('.badge').textContent).toBe(
  122. 'Rebuild Failed'
  123. );
  124. expect(packageElement.querySelector('pre').textContent).toBe(
  125. 'The build failed'
  126. );
  127. });
  128. });
  129. });
  130. describe('when there are incompatible packages', () => {
  131. it('renders incompatible packages and the rebuild button', () => {
  132. waitsForPromise(async () => {
  133. let component = new IncompatiblePackagesComponent({
  134. getActivePackages: () => packages,
  135. getLoadedPackages: () => packages
  136. });
  137. let { element } = component;
  138. await etchScheduler.getNextUpdatePromise();
  139. expect(
  140. element.querySelectorAll('.incompatible-package').length
  141. ).toEqual(2);
  142. expect(element.querySelector('button')).not.toBeNull();
  143. });
  144. });
  145. describe('when the "Rebuild All" button is clicked', () => {
  146. it("rebuilds every incompatible package, updating each package's view with status", () => {
  147. waitsForPromise(async () => {
  148. let component = new IncompatiblePackagesComponent({
  149. getActivePackages: () => packages,
  150. getLoadedPackages: () => packages
  151. });
  152. let { element } = component;
  153. jasmine.attachToDOM(element);
  154. await etchScheduler.getNextUpdatePromise();
  155. component.refs.rebuildButton.dispatchEvent(
  156. new CustomEvent('click', { bubbles: true })
  157. );
  158. await etchScheduler.getNextUpdatePromise(); // view update
  159. expect(component.refs.rebuildButton.disabled).toBe(true);
  160. expect(packages[0].resolveRebuild).toBeDefined();
  161. expect(
  162. element.querySelector('.incompatible-package:nth-child(1) .badge')
  163. .textContent
  164. ).toBe('Rebuilding');
  165. expect(
  166. element.querySelector('.incompatible-package:nth-child(2) .badge')
  167. ).toBeNull();
  168. packages[0].resolveRebuild({ code: 0 }); // simulate rebuild success
  169. await etchScheduler.getNextUpdatePromise(); // view update
  170. expect(packages[1].resolveRebuild).toBeDefined();
  171. expect(
  172. element.querySelector('.incompatible-package:nth-child(1) .badge')
  173. .textContent
  174. ).toBe('Rebuild Succeeded');
  175. expect(
  176. element.querySelector('.incompatible-package:nth-child(2) .badge')
  177. .textContent
  178. ).toBe('Rebuilding');
  179. packages[1].resolveRebuild({
  180. code: 12,
  181. stderr: 'This is an error from the test!'
  182. }); // simulate rebuild failure
  183. await etchScheduler.getNextUpdatePromise(); // view update
  184. expect(
  185. element.querySelector('.incompatible-package:nth-child(1) .badge')
  186. .textContent
  187. ).toBe('Rebuild Succeeded');
  188. expect(
  189. element.querySelector('.incompatible-package:nth-child(2) .badge')
  190. .textContent
  191. ).toBe('Rebuild Failed');
  192. expect(
  193. element.querySelector('.incompatible-package:nth-child(2) pre')
  194. .textContent
  195. ).toBe('This is an error from the test!');
  196. });
  197. });
  198. it('displays a prompt to reload Atom when the packages finish rebuilding', () => {
  199. waitsForPromise(async () => {
  200. let component = new IncompatiblePackagesComponent({
  201. getActivePackages: () => packages,
  202. getLoadedPackages: () => packages
  203. });
  204. let { element } = component;
  205. jasmine.attachToDOM(element);
  206. await etchScheduler.getNextUpdatePromise(); // view update
  207. component.refs.rebuildButton.dispatchEvent(
  208. new CustomEvent('click', { bubbles: true })
  209. );
  210. expect(packages[0].resolveRebuild({ code: 0 }));
  211. await new Promise(global.setImmediate);
  212. expect(packages[1].resolveRebuild({ code: 0 }));
  213. await etchScheduler.getNextUpdatePromise(); // view update
  214. expect(component.refs.reloadButton).toBeDefined();
  215. expect(element.querySelector('.alert').textContent).toMatch(/2 of 2/);
  216. spyOn(atom, 'reload');
  217. component.refs.reloadButton.dispatchEvent(
  218. new CustomEvent('click', { bubbles: true })
  219. );
  220. expect(atom.reload).toHaveBeenCalled();
  221. });
  222. });
  223. });
  224. describe('when the "Package Settings" button is clicked', () => {
  225. it('opens the settings panel for the package', () => {
  226. waitsForPromise(async () => {
  227. let component = new IncompatiblePackagesComponent({
  228. getActivePackages: () => packages,
  229. getLoadedPackages: () => packages
  230. });
  231. let { element } = component;
  232. jasmine.attachToDOM(element);
  233. await etchScheduler.getNextUpdatePromise();
  234. spyOn(atom.workspace, 'open');
  235. element
  236. .querySelector('.incompatible-package:nth-child(2) button')
  237. .dispatchEvent(new CustomEvent('click', { bubbles: true }));
  238. expect(atom.workspace.open).toHaveBeenCalledWith(
  239. 'atom://config/packages/incompatible-2'
  240. );
  241. });
  242. });
  243. });
  244. });
  245. });