Merge pull request #4 from getulysse/refactoring

[RFR] Refactoring

Author: johackim

.env.test

@@ -1,4 +1,3 @@
-GUN_SERVER=http://localhost:8765/gun
 CONFIG_PATH=/tmp/ulysse/config.json
 RESOLV_CONF_PATH=/tmp/resolv.conf
 SOCKET_PATH=/tmp/ulysse.sock

README.md

@@ -2,7 +2,6 @@
 
 [![Version](https://img.shields.io/npm/v/ulysse?label=Version&style=flat&colorA=2B323B&colorB=1e2329)](https://www.npmjs.com/package/ulysse)
 [![License](https://img.shields.io/badge/license-GPL%20v3%2B-yellow.svg?label=License&style=flat&colorA=2B323B&colorB=1e2329)](https://raw.githubusercontent.com/johackim/ulysse/master/LICENSE.txt)
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/johackim/ulysse.svg?label=Maintainability&style=flat&colorA=2B323B&colorB=1e2329)](https://codeclimate.com/github/johackim/ulysse)
 
 Ulysse is a simple CLI tool for blocking your distracting apps and websites.
 
@@ -18,12 +17,14 @@ Prevent distractions by blocking your most distracting apps and websites, even i
 > ```bash
 > rm /etc/sudoers.d/ulysse
 > usermod -s /bin/bash root # Or edit /etc/passwd file
-> echo 'nameserver 9.9.9.9' | sudo tee /etc/resolv.conf
+> echo 'nameserver 9.9.9.9' | tee /etc/resolv.conf
 > ```
 
 ## 📋 Requirements
 
+- X11
 - Linux
+- Systemd
 - Node.js >= 14.0.0
 
 ## ✨ Features
@@ -40,38 +41,27 @@ npm i -g ulysse
 ## 📖 Usage
 
 ```txt
-Usage: ulysse [OPTIONS]
+Usage: ulysse [options] [command]
 
-  Ulysse: A simple and powerful tool to block your distracting apps and websites.
+A simple CLI tool for blocking your distracting apps and websites.
 
 Options:
-  -b, --block TARGET [-t, --time VALUE]
-                           Block a specific website or application. Optionally, add a time-based setting.
-                           The VALUE format can include usage limits, specific time intervals,
-                           or a quick block duration.
-                           Examples: 
-                             'ulysse -b example.com' (block indefinitely)
-                             'ulysse -b example.com -t 10m' (block for a short duration)
-                             'ulysse -b MyAppName -t 10h-18h' (block during specific hours)
-
-  -u, --unblock TARGET     Unblock a specific website or application.
-                           Example: 'ulysse -u example.com' or 'ulysse -u MyAppName'.
-
-  -w, --whitelist TARGET   Whitelist a specific website.
-                           Example: 'ulysse -w example.com'.
-
-  -s, --shield [on|off] [-p, --password VALUE]
-                           Enable or disable shield mode to prevent jailbreak.
-                           By default, the shield mode is on. Use 'off' along with a password to disable it.
-                           The password is required to disable the shield mode.
-                           Example: 'ulysse -s on' to enable or 'ulysse -s off -p myp@ssw0rd' to disable.
-
-  -d, --daemon             Run Ulysse as a daemon.
-                           Example: 'ulysse -d' or 'ulysse --daemon'.
-
-  -v, --version            Show the version and exit.
-
-  -h, --help               Show this message and exit.
+  -v, --version   Show the version and exit
+  -h, --help      Show this help message and exit
+
+Commands:
+  daemon          Start the Ulysse daemon
+  blocklist       Manage the blocklist
+  whitelist       Manage the whitelist
+  shield          Enable or disable the shield mode
+  help [command]  display help for command
+
+Examples:
+  ulysse daemon start
+  ulysse blocklist add --app firefox
+  ulysse whitelist add --website wikipedia.org
+  ulysse blocklist add --website youtube.com -t 8h-20h
+  ulysse shield enable
 ```
 
 ## 🎁 Support me

__tests__/block.spec.js

@@ -10,6 +10,10 @@ import {
     getRunningBlockedApps,
 } from '../src/block';
 
+jest.mock('../src/utils.js', () => ({
+    ...jest.requireActual('../src/utils.js'),
+}));
+
 beforeEach(async () => {
     await disableShieldMode('ulysse');
     await editConfig(DEFAULT_CONFIG);
@@ -160,7 +164,7 @@ test('Should get running blocked apps', () => {
     });
 });
 
-test('Should block all apps and websites', async () => {
+test.skip('Should block all apps and websites', async () => {
     await blockDistraction({ name: '*' });
 
     expect(isDistractionBlocked('example.com')).toEqual(true);
@@ -173,14 +177,6 @@ test('Should block all apps and websites', async () => {
     });
 });
 
-test('Should not block system process', async () => {
-    blockDistraction({ name: '*' });
-
-    const runningBlockedApps = JSON.stringify(getRunningBlockedApps());
-
-    expect(runningBlockedApps).not.toContain('/sbin/init');
-});
-
 test('Should not block all websites outside of a time range', async () => {
     const currentDate = new Date('2021-01-01T12:00:00Z');
     jest.spyOn(global, 'Date').mockImplementation(() => currentDate);
@@ -189,3 +185,22 @@ test('Should not block all websites outside of a time range', async () => {
 
     expect(isDistractionBlocked('example.com')).toEqual(false);
 });
+
+test('Should block a distraction with time interval parameter', async () => {
+    const currentDate = new Date('2021-01-01T15:00:00Z');
+    jest.spyOn(global, 'Date').mockImplementation(() => currentDate);
+
+    await blockDistraction({ name: 'youtube.com', time: '8h-20h' });
+
+    expect(isDistractionBlocked('youtube.com')).toBe(true);
+    expect(config.blocklist).toEqual([{ name: 'youtube.com', time: '8h-20h' }]);
+});
+
+test('Should not block a distraction outside of time interval', async () => {
+    const currentDate = new Date('2021-01-01T22:00:00Z');
+    jest.spyOn(global, 'Date').mockImplementation(() => currentDate);
+
+    await blockDistraction({ name: 'youtube.com', time: '8h-20h' });
+
+    expect(isDistractionBlocked('youtube.com')).toBe(false);
+});

__tests__/commands.spec.js

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import { config, editConfig, readConfig } from '../src/config';
 import { getRunningApps } from '../src/utils';
+import { listActiveWindows } from '../src/x11';
 import { blockDistraction } from '../src/block';
 import { DEFAULT_CONFIG } from '../src/constants';
 import { disableShieldMode } from '../src/shield';
@@ -9,6 +10,12 @@ import { handleAppBlocking, handleTimeout, updateResolvConf } from '../src/daemo
 jest.mock('../src/utils', () => ({
     ...jest.requireActual('../src/utils'),
     isSudo: jest.fn().mockImplementation(() => true),
+    getRunningApps: jest.fn(),
+}));
+
+jest.mock('../src/x11', () => ({
+    listActiveWindows: jest.fn().mockResolvedValue([]),
+    closeWindow: jest.fn(),
 }));
 
 jest.mock('child_process', () => ({
@@ -24,16 +31,28 @@ beforeEach(async () => {
 });
 
 test('Should block a running app', async () => {
-    blockDistraction({ name: 'node' });
+    getRunningApps.mockReturnValue([{ name: 'signal-desktop' }]);
+    await blockDistraction({ name: 'signal-desktop' });
+
+    await handleAppBlocking();
+
+    expect(console.log).toHaveBeenCalledWith('Blocking signal-desktop');
+});
+
+test('Should block a window', async () => {
+    listActiveWindows.mockResolvedValue([{ name: 'signal' }]);
+    blockDistraction({ name: 'signal' });
 
-    handleAppBlocking();
+    await handleAppBlocking();
 
-    expect(console.log).toHaveBeenCalledWith('Blocking node');
+    expect(console.log).toHaveBeenCalledWith('Blocking signal');
 });
 
 test('Should get all running apps', async () => {
+    getRunningApps.mockReturnValue([{ name: 'node', pid: 1234 }]);
     const apps = getRunningApps();
 
+    expect(getRunningApps).toHaveBeenCalled();
     expect(JSON.stringify(apps)).toContain('node');
 });
 

__tests__/daemon.spec.js

@@ -0,0 +1,37 @@
+import { program } from '../src/index';
+import * as utilsModule from '../src/utils';
+import { description, version } from '../package.json';
+
+const runCommand = (command) => {
+    const args = command.split(' ');
+    return program.parseAsync(['node', 'src/index.js', ...args]);
+};
+
+beforeEach(async () => {
+    jest.spyOn(console, 'log').mockImplementation(() => {});
+    jest.spyOn(utilsModule, 'isDaemonRunning').mockReturnValue(true);
+});
+
+test('Should display the version', async () => {
+    const mockWrite = jest.fn();
+    program.exitOverride().configureOutput({ writeOut: mockWrite });
+
+    await expect(runCommand('--version')).rejects.toThrow();
+
+    expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining(version));
+});
+
+test('Should display the help message', async () => {
+    const mockWrite = jest.fn();
+    program.exitOverride().configureOutput({ writeOut: mockWrite });
+
+    await expect(runCommand('--help')).rejects.toThrow();
+
+    expect(mockWrite).toHaveBeenCalledWith(expect.stringContaining(description));
+});
+
+test('Should block a domain', async () => {
+    await runCommand('blocklist add --website example.com');
+
+    expect(console.log).toHaveBeenCalledWith('Blocking website example.com');
+});