README

<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Apache Pulsar Dev Tools

Running Integration Tests on macOS

Currently all the integration tests are docker based and written using testcontainers framework. Due to the networking issues, the integration tests can only be run on linux environment. For people who is using macOS as their development environment, you can use Vagrant to launch a linux virtual machine and run the integration tests there.

1. Download and Install Vagrant.

2. Provision and launch the dev vm.

   shellCopy

   $ cd ${PULSAR_HOME}/dev
   
   # provision the vm
   $ vagrant up
   

3. The dev vm will try to mount your current pulsar workspace to be under /pulsar in the vm. You might potentially hit following errors due to fail to install VirtualBox Guest additions.

   Copy

   /sbin/mount.vboxsf: mounting failed with the error: No such device
   

   If that happens, follow the below instructions:

   Copy

    $ vagrant plugin install vagrant-vbguest
    $ vagrant destroy && vagrant up
   
   # reload the vm
   $ vagrant reload
   

4. Now, you will have a pulsar dev vm ready for running integration tests.

   shellCopy

   $ vagrant ssh
   
   # once you are in the pulsar dev vm, you can launch docker.
   [vagrant@bogon pulsar]$ sudo systemctl start docker
   
   # your pulsar workspace will be mount under /pulsar
   [vagrant@bogon pulsar]$ cd /pulsar
   
   # you can build and test using maven commands