Merge pull request #260 from oslabs-beta/main

Chronos 11

Author: jeffreyNa

CONTRIBUTING.md

@@ -14,19 +14,24 @@ Chronos welcomes all pull requests.
 6. Create a pull request to `master`.
 
 ## Getting started
-- `npm run bot`: Run Node and Electron at the same time to start Chronos app
-  - To make changes to codebase on the Main Process
+- `npm run dev:app` and `npm run dev:electron`: Run Node and Electron at the same time to start Chronos app
+  - To make changes to codebase on the Main Process:
     - Files in the main process must be compiled prior to starting the app
-      - In the terminal un Chronos directory, input `tsc` to comile typescript files
-      - Once compiled, `npm run both`
-      * Note** If typescript is not installed, `npm install -g typescript` 
+      - In the terminal in Chronos directory, input `tsc` to compile typescript files
+      - Once compiled, `npm run dev:app` and `npm run dev:electron`
+      * Note: If typescript is not installed, `npm install -g typescript` 
 
+## Chronos Website
+
+The `chronosWebsite` branch holds the code for the website. Edit the website by checking out the branch, modifying the website, and then updating the AWS S3 bucket with the changes.
 ## Issues
 
-Please do not hesitate to file issues. Chronos is based off of community feedback and is  always looking for ways to get better. The team behind Chronos is interested to hear about your experience and how we can improve it.
+Please do not hesitate to file issues that detail bugs or offer ways to enhace Chronos.
+
+Chronos is based off of community feedback and is  always looking for ways to get better. The team behind Chronos is interested to hear about your experience and how we can improve it.
 
-Please do not hesitate to submit issues that promote bugs or offer ways to enhance to Chronos. When submitting issues, ensure your description is clear and has instructions to be able to reproduce the issue.
+When submitting issues, ensure your description is clear and has instructions to be able to reproduce the issue.
 
-## Get in touch
+## Get In Touch
 
-We use GitHub as a platform of communication between users and developers to promote transparency. We thrive off of the community support and feedback
+We use GitHub as a platform of communication between users and developers to promote transparency, community support and feedback.

README.md

@@ -5,7 +5,6 @@
 1. React Testing Library versions 13+ require React v18. If your project uses an older version of React, be sure to install version 12
 ```
 npm install --save-dev @testing-library/react@12
-
 ``` 
 2. install additional packages
 ```
@@ -55,12 +54,9 @@ module.exports = {
 
 6. use `npm run test` to run jest tests
 
-### Contributing
+## Contributing
 
 Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
 
-### People
-[Snow X. Bai](https://github.com/xueapp)
-[Taylor Zhang](https://github.com/taylrzhang)
-[Tim Lee](https://github.com/timlee12)
-[Roberto Meloni](https://github.com/RobertoRueMeloni)
+Read our [contributing README](../../CONTRIBUTING.md) to further learn how you can take part in improving Chronos.
+

__tests__/README.md

@@ -0,0 +1,66 @@
+import React from 'react';
+import HealthChart from '../../app/charts/HealthChart';
+import { render, screen } from '@testing-library/react';
+
+// mockData used for testing suite
+const mockData = {
+  ServiceName: {
+    Metric: {
+      time: [
+        '2023-06-09T15:18:25.195Z',
+        '2023-06-09T15:18:20.194Z',
+        '2023-06-09T15:18:15.192Z',
+        '2023-06-09T15:18:10.191Z',
+        '2023-06-09T15:18:05.190Z',
+      ],
+      value: [1208074240, 1282670592, 1243414528, 1278115840, 117178368],
+    },
+  },
+};
+
+jest.mock('electron', () => ({
+  ipcRenderer: {
+    send: () => jest.fn(),
+    on: () => mockData,
+  },
+}));
+
+// test suite for HealthChart.tsx
+describe('HealthChart', () => {
+  const props = {
+    key: 'testKey',
+    dataType: 'Memory in Megabytes',
+    serviceName: 'serviceName',
+    chartData: mockData,
+    categoryName: 'Test Name',
+    sizing: 'all',
+    colourGenerator: jest.fn(),
+  };
+
+  let graph;
+  beforeEach(() => {
+    render(<HealthChart {...props} />);
+
+    graph = screen.getByTestId('Health Chart').firstChild;
+  });
+
+  it('Should render', () => {
+    expect(screen).toBeTruthy();
+  });
+
+  it('Should render graph', () => {
+    expect(graph).toBeTruthy();
+  });
+
+  it('Should not scroll', () => {
+    expect(graph.scrollWidth).toBe(0);
+    expect(graph.scrollHeight).toBe(0);
+    expect(graph.scrollLeft).toBe(0);
+    expect(graph.scrollTop).toBe(0);
+  });
+
+  it('Should have correct data on y-axis based off mock data', () => {
+    expect(graph.data[0].y[0]).toBe((mockData.ServiceName.Metric.value[0] / 1000000).toFixed(2));
+    expect(graph.data[0].y[1]).toBe((mockData.ServiceName.Metric.value[1] / 1000000).toFixed(2));
+  });
+});