Plotly Falcon SQL 客户端开发环境搭建与测试指南

项目概述

Plotly Falcon SQL 客户端是一个功能强大的数据库连接工具，支持多种数据库系统，包括 IBM DB2 和 Oracle 等。它既可以作为 Electron 桌面应用运行，也可以作为 Web 应用部署。本文将详细介绍如何搭建开发环境、构建应用以及进行测试。

开发环境准备

系统要求

• Node.js v8 或更高版本
• Yarn v1 包管理器
• 对于 Oracle 连接器开发，还需要安装 Oracle 客户端库

环境搭建步骤

1. 克隆项目仓库：

git clone <项目地址> falcon-sql-client
cd falcon-sql-client

2. 安装项目依赖：

yarn install

应用构建与运行

Electron 应用构建

1. 针对 Electron 重建原生模块：

yarn run rebuild:modules:electron

2. 构建并运行应用：

yarn run build
yarn run start

Web 应用构建

1. 如果需要从 Electron 构建切换，先重建 Node 原生模块：

yarn run rebuild:modules:node

2. 构建并启动 Web 服务：

yarn run heroku-postbuild
yarn run start-headless

应用将在本地 9494 端口运行，可通过浏览器访问。

Docker 部署

容器化运行

1. 构建 Docker 镜像：

yarn run docker:falcon:build

2. 启动容器（禁用认证）：

PLOTLY_CONNECTOR_AUTH_ENABLED=false yarn run docker:falcon:start

开发工作流

实时开发模式

启动以下监视器以实现实时开发：

# 主进程监视
yarn run watch-main

# 前端资源监视
yarn run watch-web

# 无头模式监视
yarn run watch-headless

然后通过以下命令启动开发版应用：

yarn run dev

完整重建流程

当遇到构建问题时，可执行完整重建：

yarn install
yarn run rebuild:modules:electron
rm -rf dist
yarn run build
yarn start

测试体系

测试类型

1. 后端测试：

   • 位置：test/backend
   • 运行命令：yarn run test-unit-all

2. 前端测试：

   • 位置：test/app
   • 运行命令：yarn run test-jest

3. 集成测试：

   • 主文件：test/integration_test.js
   • 运行命令：yarn run test-e2e

数据库测试环境

IBM DB2 测试环境

1. 构建镜像：

yarn run docker:db2:build

2. 启动容器：

yarn run docker:db2:start

Oracle 测试环境

1. 构建镜像：

yarn run docker:oracle:build

2. 启动容器：

yarn run docker:oracle:start

Oracle 客户端安装指南

在 Ubuntu 系统上安装 Oracle 客户端库：

1. 安装依赖：

sudo apt-get -qq update && sudo apt-get --no-install-recommends -qq install alien bc libaio1

2. 下载并安装 Instant Client：

unzip oracle-xe-11.2.0-1.0.x86_64.rpm.zip
alien oracle-xe-11.2.0-1.0.x86_64.rpm
sudo dpkg -i oracle-instantclient12.2-basiclite_12.2.0.1.0-2_amd64.deb

运行 Oracle 单元测试

1. 启动 Oracle 测试容器：

yarn run docker:oracle:start

2. 设置环境变量并运行测试：

export LD_LIBRARY_PATH=/usr/lib/oracle/12.2/client64/lib:$LD_LIBRARY_PATH
yarn run test-unit-oracle

常见问题解决

配置问题

当遇到配置损坏导致启动失败时，可删除配置目录：

• Windows：

rmdir /s %USERPROFILE%\.plotly\connector

• Mac/Linux：

rm -rf ~/.plotly/connector/

结语

本文详细介绍了 Plotly Falcon SQL 客户端的开发环境搭建、构建运行方法以及测试体系。通过遵循这些步骤，开发者可以快速开始项目贡献或进行二次开发。对于企业级部署，建议参考官方文档获取更详细的配置指南。