Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Feature/Set up unit test that loads activity from exported json file (#3901)

Dhaneshwari Tendle7a11bb93d5ba
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 388fd97723..d83247b12b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Added the name to the tooltip of the chart of the holdings tab on the home page (experimental)
+### Changed
+
+- Improved the portfolio unit tests to work with exported activity files
+
### Fixed
- Considered the language of the user settings on login with _Security Token_
diff --git a/apps/api/src/app/portfolio/calculator/portfolio-calculator-test-utils.ts b/apps/api/src/app/portfolio/calculator/portfolio-calculator-test-utils.ts
index d458be7087..217ec499b5 100644
--- a/apps/api/src/app/portfolio/calculator/portfolio-calculator-test-utils.ts
+++ b/apps/api/src/app/portfolio/calculator/portfolio-calculator-test-utils.ts
@@ -1,3 +1,5 @@
+import { readFileSync } from 'fs';
+
export const activityDummyData = {
accountId: undefined,
accountUserId: undefined,
@@ -29,3 +31,7 @@ export const symbolProfileDummyData = {
export const userDummyData = {
id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
};
+
+export function loadActivityExportFile(filePath: string) {
+ return JSON.parse(readFileSync(filePath, 'utf8')).activities;
+}
diff --git a/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator-novn-buy-and-sell.spec.ts b/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator-novn-buy-and-sell.spec.ts
index db5aaf6bc6..66cdb9e8e4 100644
--- a/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator-novn-buy-and-sell.spec.ts
+++ b/apps/api/src/app/portfolio/calculator/twr/portfolio-calculator-novn-buy-and-sell.spec.ts
@@ -1,259 +1,253 @@
-import { Activity } from '@ghostfolio/api/app/order/interfaces/activities.interface';
-import {
- activityDummyData,
- symbolProfileDummyData,
- userDummyData
-} from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator-test-utils';
-import {
- PerformanceCalculationType,
- PortfolioCalculatorFactory
-} from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator.factory';
-import { CurrentRateService } from '@ghostfolio/api/app/portfolio/current-rate.service';
-import { CurrentRateServiceMock } from '@ghostfolio/api/app/portfolio/current-rate.service.mock';
-import { RedisCacheService } from '@ghostfolio/api/app/redis-cache/redis-cache.service';
-import { RedisCacheServiceMock } from '@ghostfolio/api/app/redis-cache/redis-cache.service.mock';
-import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';
-import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';
-import { PortfolioSnapshotService } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service';
-import { PortfolioSnapshotServiceMock } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service.mock';
-import { parseDate } from '@ghostfolio/common/helper';
-
-import { Big } from 'big.js';
-import { last } from 'lodash';
-
-jest.mock('@ghostfolio/api/app/portfolio/current-rate.service', () => {
- return {
- // eslint-disable-next-line @typescript-eslint/naming-convention
- CurrentRateService: jest.fn().mockImplementation(() => {
- return CurrentRateServiceMock;
- })
- };
-});
-
-jest.mock(
- '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service',
- () => {
- return {
- // eslint-disable-next-line @typescript-eslint/naming-convention
- PortfolioSnapshotService: jest.fn().mockImplementation(() => {
- return PortfolioSnapshotServiceMock;
- })
- };
- }
-);
-
-jest.mock('@ghostfolio/api/app/redis-cache/redis-cache.service', () => {
- return {
- // eslint-disable-next-line @typescript-eslint/naming-convention
- RedisCacheService: jest.fn().mockImplementation(() => {
- return RedisCacheServiceMock;
- })
- };
-});
-
-describe('PortfolioCalculator', () => {
- let configurationService: ConfigurationService;
- let currentRateService: CurrentRateService;
- let exchangeRateDataService: ExchangeRateDataService;
- let portfolioCalculatorFactory: PortfolioCalculatorFactory;
- let portfolioSnapshotService: PortfolioSnapshotService;
- let redisCacheService: RedisCacheService;
-
- beforeEach(() => {
- configurationService = new ConfigurationService();
-
- currentRateService = new CurrentRateService(null, null, null, null);
-
- exchangeRateDataService = new ExchangeRateDataService(
- null,
- null,
- null,
- null
- );
-
- portfolioSnapshotService = new PortfolioSnapshotService(null);
-
- redisCacheService = new RedisCacheService(null, null);
-
- portfolioCalculatorFactory = new PortfolioCalculatorFactory(
- configurationService,
- currentRateService,
- exchangeRateDataService,
- portfolioSnapshotService,
- redisCacheService
- );
- });
-
- describe('get current positions', () => {
- it.only('with NOVN.SW buy and sell', async () => {
- jest.useFakeTimers().setSystemTime(parseDate('2022-04-11').getTime());
-
- const activities: Activity[] = [
- {
- ...activityDummyData,
- date: new Date('2022-03-07'),
- fee: 0,
- quantity: 2,
- SymbolProfile: {
- ...symbolProfileDummyData,
- currency: 'CHF',
- dataSource: 'YAHOO',
- name: 'Novartis AG',
- symbol: 'NOVN.SW'
- },
- type: 'BUY',
- unitPrice: 75.8
- },
- {
- ...activityDummyData,
- date: new Date('2022-04-08'),
- fee: 0,
- quantity: 2,
- SymbolProfile: {
- ...symbolProfileDummyData,
- currency: 'CHF',
- dataSource: 'YAHOO',
- name: 'Novartis AG',
- symbol: 'NOVN.SW'
- },
- type: 'SELL',
- unitPrice: 85.73
- }
- ];
-
- const portfolioCalculator = portfolioCalculatorFactory.createCalculator({
- activities,
- calculationType: PerformanceCalculationType.TWR,
- currency: 'CHF',
- userId: userDummyData.id
- });
-
- const portfolioSnapshot = await portfolioCalculator.computeSnapshot();
-
- const investments = portfolioCalculator.getInvestments();
-
- const investmentsByMonth = portfolioCalculator.getInvestmentsByGroup({
- data: portfolioSnapshot.historicalData,
- groupBy: 'month'
- });
-
- expect(portfolioSnapshot.historicalData[0]).toEqual({
- date: '2022-03-06',
- investmentValueWithCurrencyEffect: 0,
- netPerformance: 0,
- netPerformanceInPercentage: 0,
- netPerformanceInPercentageWithCurrencyEffect: 0,
- netPerformanceWithCurrencyEffect: 0,
- netWorth: 0,
- totalAccountBalance: 0,
- totalInvestment: 0,
- totalInvestmentValueWithCurrencyEffect: 0,
- value: 0,
- valueWithCurrencyEffect: 0
- });
-
- expect(portfolioSnapshot.historicalData[1]).toEqual({
- date: '2022-03-07',
- investmentValueWithCurrencyEffect: 151.6,
- netPerformance: 0,
- netPerformanceInPercentage: 0,
- netPerformanceInPercentageWithCurrencyEffect: 0,
- netPerformanceWithCurrencyEffect: 0,
- netWorth: 151.6,
- totalAccountBalance: 0,
- totalInvestment: 151.6,
- totalInvestmentValueWithCurrencyEffect: 151.6,
- value: 151.6,
- valueWithCurrencyEffect: 151.6
- });
-
- expect(
- portfolioSnapshot.historicalData[
- portfolioSnapshot.historicalData.length - 1
- ]
- ).toEqual({
- date: '2022-04-11',
- investmentValueWithCurrencyEffect: 0,
- netPerformance: 19.86,
- netPerformanceInPercentage: 0.13100263852242744,
- netPerformanceInPercentageWithCurrencyEffect: 0.13100263852242744,
- netPerformanceWithCurrencyEffect: 19.86,
- netWorth: 0,
- totalAccountBalance: 0,
- totalInvestment: 0,
- totalInvestmentValueWithCurrencyEffect: 0,
- value: 0,
- valueWithCurrencyEffect: 0
- });
-
- expect(portfolioSnapshot).toMatchObject({
- currentValueInBaseCurrency: new Big('0'),
- errors: [],
- hasErrors: false,
- positions: [
- {
- averagePrice: new Big('0'),
- currency: 'CHF',
- dataSource: 'YAHOO',
- dividend: new Big('0'),
- dividendInBaseCurrency: new Big('0'),
- fee: new Big('0'),
- feeInBaseCurrency: new Big('0'),
- firstBuyDate: '2022-03-07',
- grossPerformance: new Big('19.86'),
- grossPerformancePercentage: new Big('0.13100263852242744063'),
- grossPerformancePercentageWithCurrencyEffect: new Big(
- '0.13100263852242744063'
- ),
- grossPerformanceWithCurrencyEffect: new Big('19.86'),
- investment: new Big('0'),
- investmentWithCurrencyEffect: new Big('0'),
- netPerformance: new Big('19.86'),
- netPerformancePercentage: new Big('0.13100263852242744063'),
- netPerformancePercentageWithCurrencyEffectMap: {
- max: new Big('0.13100263852242744063')
- },
- netPerformanceWithCurrencyEffectMap: {
- max: new Big('19.86')
- },
- marketPrice: 87.8,
- marketPriceInBaseCurrency: 87.8,
- quantity: new Big('0'),
- symbol: 'NOVN.SW',
- tags: [],
- timeWeightedInvestment: new Big('151.6'),
- timeWeightedInvestmentWithCurrencyEffect: new Big('151.6'),
- transactionCount: 2,
- valueInBaseCurrency: new Big('0')
- }
- ],
- totalFeesWithCurrencyEffect: new Big('0'),
- totalInterestWithCurrencyEffect: new Big('0'),
- totalInvestment: new Big('0'),
- totalInvestmentWithCurrencyEffect: new Big('0'),
- totalLiabilitiesWithCurrencyEffect: new Big('0'),
- totalValuablesWithCurrencyEffect: new Big('0')
- });
-
- expect(last(portfolioSnapshot.historicalData)).toMatchObject(
- expect.objectContaining({
- netPerformance: 19.86,
- netPerformanceInPercentage: 0.13100263852242744063,
- netPerformanceInPercentageWithCurrencyEffect: 0.13100263852242744063,
- netPerformanceWithCurrencyEffect: 19.86,
- totalInvestmentValueWithCurrencyEffect: 0
- })
- );
-
- expect(investments).toEqual([
- { date: '2022-03-07', investment: new Big('151.6') },
- { date: '2022-04-08', investment: new Big('0') }
- ]);
-
- expect(investmentsByMonth).toEqual([
- { date: '2022-03-01', investment: 151.6 },
- { date: '2022-04-01', investment: -151.6 }
- ]);
- });
- });
-});
+import { CreateOrderDto } from '@ghostfolio/api/app/order/create-order.dto';
+import { Activity } from '@ghostfolio/api/app/order/interfaces/activities.interface';
+import {
+ activityDummyData,
+ loadActivityExportFile,
+ symbolProfileDummyData,
+ userDummyData
+} from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator-test-utils';
+import {
+ PerformanceCalculationType,
+ PortfolioCalculatorFactory
+} from '@ghostfolio/api/app/portfolio/calculator/portfolio-calculator.factory';
+import { CurrentRateService } from '@ghostfolio/api/app/portfolio/current-rate.service';
+import { CurrentRateServiceMock } from '@ghostfolio/api/app/portfolio/current-rate.service.mock';
+import { RedisCacheService } from '@ghostfolio/api/app/redis-cache/redis-cache.service';
+import { RedisCacheServiceMock } from '@ghostfolio/api/app/redis-cache/redis-cache.service.mock';
+import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';
+import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';
+import { PortfolioSnapshotService } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service';
+import { PortfolioSnapshotServiceMock } from '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service.mock';
+import { parseDate } from '@ghostfolio/common/helper';
+
+import { Big } from 'big.js';
+import { last } from 'lodash';
+import { join } from 'path';
+
+jest.mock('@ghostfolio/api/app/portfolio/current-rate.service', () => {
+ return {
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ CurrentRateService: jest.fn().mockImplementation(() => {
+ return CurrentRateServiceMock;
+ })
+ };
+});
+
+jest.mock(
+ '@ghostfolio/api/services/queues/portfolio-snapshot/portfolio-snapshot.service',
+ () => {
+ return {
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ PortfolioSnapshotService: jest.fn().mockImplementation(() => {
+ return PortfolioSnapshotServiceMock;
+ })
+ };
+ }
+);
+
+jest.mock('@ghostfolio/api/app/redis-cache/redis-cache.service', () => {
+ return {
+ // eslint-disable-next-line @typescript-eslint/naming-convention
+ RedisCacheService: jest.fn().mockImplementation(() => {
+ return RedisCacheServiceMock;
+ })
+ };
+});
+
+describe('PortfolioCalculator', () => {
+ let activityDtos: CreateOrderDto[];
+
+ let configurationService: ConfigurationService;
+ let currentRateService: CurrentRateService;
+ let exchangeRateDataService: ExchangeRateDataService;
+ let portfolioCalculatorFactory: PortfolioCalculatorFactory;
+ let portfolioSnapshotService: PortfolioSnapshotService;
+ let redisCacheService: RedisCacheService;
+
+ beforeAll(() => {
+ activityDtos = loadActivityExportFile(
+ join(
+ __dirname,
+ '../../../../../../../test/import/ok-novn-buy-and-sell.json'
+ )
+ );
+ });
+
+ beforeEach(() => {
+ configurationService = new ConfigurationService();
+
+ currentRateService = new CurrentRateService(null, null, null, null);
+
+ exchangeRateDataService = new ExchangeRateDataService(
+ null,
+ null,
+ null,
+ null
+ );
+
+ portfolioSnapshotService = new PortfolioSnapshotService(null);
+
+ redisCacheService = new RedisCacheService(null, null);
+
+ portfolioCalculatorFactory = new PortfolioCalculatorFactory(
+ configurationService,
+ currentRateService,
+ exchangeRateDataService,
+ portfolioSnapshotService,
+ redisCacheService
+ );
+ });
+
+ describe('get current positions', () => {
+ it.only('with NOVN.SW buy and sell', async () => {
+ jest.useFakeTimers().setSystemTime(parseDate('2022-04-11').getTime());
+
+ const activities: Activity[] = activityDtos.map((activity) => ({
+ ...activityDummyData,
+ ...activity,
+ date: parseDate(activity.date),
+ SymbolProfile: {
+ ...symbolProfileDummyData,
+ currency: activity.currency,
+ dataSource: activity.dataSource,
+ name: 'Novartis AG',
+ symbol: activity.symbol
+ }
+ }));
+
+ const portfolioCalculator = portfolioCalculatorFactory.createCalculator({
+ activities,
+ calculationType: PerformanceCalculationType.TWR,
+ currency: 'CHF',
+ userId: userDummyData.id
+ });
+
+ const portfolioSnapshot = await portfolioCalculator.computeSnapshot();
+
+ const investments = portfolioCalculator.getInvestments();
+
+ const investmentsByMonth = portfolioCalculator.getInvestmentsByGroup({
+ data: portfolioSnapshot.historicalData,
+ groupBy: 'month'
+ });
+
+ expect(portfolioSnapshot.historicalData[0]).toEqual({
+ date: '2022-03-06',
+ investmentValueWithCurrencyEffect: 0,
+ netPerformance: 0,
+ netPerformanceInPercentage: 0,
+ netPerformanceInPercentageWithCurrencyEffect: 0,
+ netPerformanceWithCurrencyEffect: 0,
+ netWorth: 0,
+ totalAccountBalance: 0,
+ totalInvestment: 0,
+ totalInvestmentValueWithCurrencyEffect: 0,
+ value: 0,
+ valueWithCurrencyEffect: 0
+ });
+
+ expect(portfolioSnapshot.historicalData[1]).toEqual({
+ date: '2022-03-07',
+ investmentValueWithCurrencyEffect: 151.6,
+ netPerformance: 0,
+ netPerformanceInPercentage: 0,
+ netPerformanceInPercentageWithCurrencyEffect: 0,
+ netPerformanceWithCurrencyEffect: 0,
+ netWorth: 151.6,
+ totalAccountBalance: 0,
+ totalInvestment: 151.6,
+ totalInvestmentValueWithCurrencyEffect: 151.6,
+ value: 151.6,
+ valueWithCurrencyEffect: 151.6
+ });
+
+ expect(
+ portfolioSnapshot.historicalData[
+ portfolioSnapshot.historicalData.length - 1
+ ]
+ ).toEqual({
+ date: '2022-04-11',
+ investmentValueWithCurrencyEffect: 0,
+ netPerformance: 19.86,
+ netPerformanceInPercentage: 0.13100263852242744,
+ netPerformanceInPercentageWithCurrencyEffect: 0.13100263852242744,
+ netPerformanceWithCurrencyEffect: 19.86,
+ netWorth: 0,
+ totalAccountBalance: 0,
+ totalInvestment: 0,
+ totalInvestmentValueWithCurrencyEffect: 0,
+ value: 0,
+ valueWithCurrencyEffect: 0
+ });
+
+ expect(portfolioSnapshot).toMatchObject({
+ currentValueInBaseCurrency: new Big('0'),
+ errors: [],
+ hasErrors: false,
+ positions: [
+ {
+ averagePrice: new Big('0'),
+ currency: 'CHF',
+ dataSource: 'YAHOO',
+ dividend: new Big('0'),
+ dividendInBaseCurrency: new Big('0'),
+ fee: new Big('0'),
+ feeInBaseCurrency: new Big('0'),
+ firstBuyDate: '2022-03-07',
+ grossPerformance: new Big('19.86'),
+ grossPerformancePercentage: new Big('0.13100263852242744063'),
+ grossPerformancePercentageWithCurrencyEffect: new Big(
+ '0.13100263852242744063'
+ ),
+ grossPerformanceWithCurrencyEffect: new Big('19.86'),
+ investment: new Big('0'),
+ investmentWithCurrencyEffect: new Big('0'),
+ netPerformance: new Big('19.86'),
+ netPerformancePercentage: new Big('0.13100263852242744063'),
+ netPerformancePercentageWithCurrencyEffectMap: {
+ max: new Big('0.13100263852242744063')
+ },
+ netPerformanceWithCurrencyEffectMap: {
+ max: new Big('19.86')
+ },
+ marketPrice: 87.8,
+ marketPriceInBaseCurrency: 87.8,
+ quantity: new Big('0'),
+ symbol: 'NOVN.SW',
+ tags: [],
+ timeWeightedInvestment: new Big('151.6'),
+ timeWeightedInvestmentWithCurrencyEffect: new Big('151.6'),
+ transactionCount: 2,
+ valueInBaseCurrency: new Big('0')
+ }
+ ],
+ totalFeesWithCurrencyEffect: new Big('0'),
+ totalInterestWithCurrencyEffect: new Big('0'),
+ totalInvestment: new Big('0'),
+ totalInvestmentWithCurrencyEffect: new Big('0'),
+ totalLiabilitiesWithCurrencyEffect: new Big('0'),
+ totalValuablesWithCurrencyEffect: new Big('0')
+ });
+
+ expect(last(portfolioSnapshot.historicalData)).toMatchObject(
+ expect.objectContaining({
+ netPerformance: 19.86,
+ netPerformanceInPercentage: 0.13100263852242744063,
+ netPerformanceInPercentageWithCurrencyEffect: 0.13100263852242744063,
+ netPerformanceWithCurrencyEffect: 19.86,
+ totalInvestmentValueWithCurrencyEffect: 0
+ })
+ );
+
+ expect(investments).toEqual([
+ { date: '2022-03-07', investment: new Big('151.6') },
+ { date: '2022-04-08', investment: new Big('0') }
+ ]);
+
+ expect(investmentsByMonth).toEqual([
+ { date: '2022-03-01', investment: 151.6 },
+ { date: '2022-04-01', investment: -151.6 }
+ ]);
+ });
+ });
+});
diff --git a/test/import/ok-novn-buy-and-sell.json b/test/import/ok-novn-buy-and-sell.json
index b8a62279d6..b7ab6aee1a 100644
--- a/test/import/ok-novn-buy-and-sell.json
+++ b/test/import/ok-novn-buy-and-sell.json
@@ -11,7 +11,7 @@
"unitPrice": 85.73,
"currency": "CHF",
"dataSource": "YAHOO",
- "date": "2022-04-07T22:00:00.000Z",
+ "date": "2022-04-08T00:00:00.000Z",
"symbol": "NOVN.SW"
},
{
@@ -21,7 +21,7 @@
"unitPrice": 75.8,
"currency": "CHF",
"dataSource": "YAHOO",
- "date": "2022-03-06T23:00:00.000Z",
+ "date": "2022-03-07T00:00:00.000Z",
"symbol": "NOVN.SW"
}
]