<p>I decided to setup my local NAS server using a raspberry Pi and a USB connected SSD. This will involve installing and configuring samba on the raspberry Pi to allow access from Windows.</p>
<p>Here are the steps I followed in order to get everything working.</p>
<ul>
<li>If your setting up your raspberry Pi for the first time, install the <a href="https://www.raspberrypi.com/software/">Raspberry Pi Imager</a> which will allow you to install the Raspberry Pi OS (aka Raspbian) onto an SD card.</li>
<li>Once you installed the Raspberry Pi Imager install the latest headless (aka desktop free) software. Ensure that you give your Pi a hostname and enable SSH.</li>
<li>Connect your raspberry Pi to your network. My raspberry Pi has the <a href="https://www.raspberrypi.com/products/poe-hat/" title="PoE hat">PoE hat</a> hence once I connect it to my network via Ethernet it will recieve power. </li>
<li>Connect your external SSD drive ensuring that it has been formatted correctly. SSH to your pi and run the following to determine whether your SSD has connected: </li>
</ul>
<p><code>sudo lsblk -o UUID,NAME,FSTYPE,SIZE,MOUNTPOINT,LABEL,MODEL</code></p>
<ul>
<li>You should see a similar result to this:</li>
</ul>
<p><img src="//images.ctfassets.net/ifshb5hrrgy8/4tOw3ZBDf9IygaKxp29Cam/4ad31eac608abba88e28d6b7c8ca565d/image.png" alt="List Disks"></p>
<ul>
<li>You should be able to see your drive in the list, take note of the path at the beginning and the label.</li>
<li>You'll need to create a folder of the location where you would like to mount your external device<ul>
<li><code>sudo mkdir /mnt/main-share-1</code></li>
</ul></li>
<li>Mount the external drive onto the share locations.<ul>
<li><code>sudo mount /dev/sda2 /mnt/main-share-1</code></li>
</ul></li>
<li>Change permissions on /mnt directory<ul>
<li><code>sudo chmod 775 /mnt/main-share-1</code></li>
</ul></li>
<li>Create a separate user for accessing the media files. Follow all the steps in the user creation wizard.<ul>
<li><code>sudo adduser mediapi</code></li>
</ul></li>
<li>List the users just to confirm that the creation went successfully
<img src="//images.ctfassets.net/ifshb5hrrgy8/3fGFDA2rzZWs2EMzhIpa4a/47cf701e46ede52b0506ec2a25ea3e42/image.png" alt="List users"></li>
<li>Install samba and then backup the config<ul>
<li><code>sudo apt install samba</code></li>
<li><code>sudo cp /etc/samba/smb.conf /etc/samba/smb.conf.bk</code></li>
</ul></li>
<li>Edit samba config<ul>
<li><code>sudo nano /etc/samba/smb.conf</code></li>
</ul></li>
<li>Add the share info at the bottom</li>
</ul>
<pre><code>        [main-share-1]
            comment = Samba on Ubuntu
            path = /mnt/main-share-1
            read only = no
    browsable = yes
</code></pre>
<ul>
<li>Then save the file</li>
<li>Restart samba server<ul>
<li><code>sudo service smbd restart</code></li>
</ul></li>
<li>Update firewall rules to allow samba<ul>
<li><code>sudo ufw allow samba</code></li>
</ul></li>
<li>Setup samba user <ul>
<li><code>sudo smbpasswd -a mediapi</code></li>
</ul></li>
</ul>
<p>The NAS configuration is complete and you should be able to access the server from a Windows PC.</p>
<ul>
<li>Go to your Windows PC and open a run dialog and type in the IP address followed by the share path in the UNC format:</li>
</ul>
<p><img src="//images.ctfassets.net/ifshb5hrrgy8/0DZuHAS7Kq8Ik0RccTK4m/15211d0104b20a3d4a8017246f3762db/image.png" alt="UNC share for NAS drive"></p>
<p>If you want you can add the network location share permantley in Windows.</p>


Creating a NAS drive can be a simple affair however maintainability becomes an issue when you are beholden to specific OEMs. An alternative is to try and configure your server as much as possible using this method of a Pi and a SSD.

Media NAS Pi Server

<h3>Introduction</h3>
<p>Below are the steps needed to setup PiHole with Unifi UDM Pro.
The sofware versions involved are:</p>
<ul>
<li>Unifi UDM Pro: Network v6.5.55</li>
<li>Raspberry PI 4: PiHole v5.8.1 </li>
</ul>
<h3>TL;DR</h3>
<p>The main actions to note are:</p>
<ul>
<li>Setup networks for devices that you require in Unifi.</li>
<li>Ensure the networks have no content filtering in Unifi.</li>
<li>Setup appropriate network/firewall rules to allow access to DNS.</li>
<li>Install and enable PiHole</li>
</ul>
<h3>Configuration</h3>
<h5>PiHole</h5>
<p>I have a raspberry Pi 4 attached to my home network. </p>
<ul>
<li>Configure &#x26; install raspbery Pi on your device:  <a href="https://www.raspberrypi.com/software/">https://www.raspberrypi.com/software/</a> make sure SSH is enabled.</li>
<li>Install PiHole <a href="https://docs.pi-hole.net/main/basic-install/">https://docs.pi-hole.net/main/basic-install/</a></li>
<li>If you have several networks/subnets set up you'll need to <strong>Permit all origins</strong></li>
<li>Go to settings -> DNS -> Interface Settings</li>
<li><img src="//images.ctfassets.net/ifshb5hrrgy8/5Q6e7LEbZHQLAVD7DC6cqH/8e035bcc266f3b4c3e20b2a60a216ecb/image.png" alt="PiHole Permit All Origins"></li>
<li>Save those changes.</li>
</ul>
<h5>Unifi</h5>
<p>I have setup 4 networks with the following CIDRs:
<a href="//images.ctfassets.net/ifshb5hrrgy8/3gkb1FLnAm1NGDfRbQpAlS/1ef1a8e89f97796c853d3e0c13928260/image.png">Unifi network CIDRs</a></p>
<p>You need to setup firewall rules to control traffic on your network but in order to allow DNS traffic to your PiHole you'll need the following:</p>
<ul>
<li>Rule Type: LAN in</li>
<li>Description: ALLOW ALL to DNS</li>
<li>Action: Accept</li>
<li>IPv4 Protocol: TCP and UDP</li>
</ul>
<p><strong>Source Settings</strong></p>
<ul>
<li>Source Type: Address/Port Group</li>
<li>IPv4 Address Group: Any</li>
<li>IPv4 Port Group: Any</li>
</ul>
<p><strong>Destination Settings</strong></p>
<ul>
<li>Destination Type: Address/Port Group</li>
<li>IPv4 Protocol: DNS Server -> Create a group with the IP of the DNS Server with PiHole.</li>
<li>Port Group: DNS Port -> Create a group with the port number <strong>53</strong>.</li>
</ul>
<p>Save those settings.</p>
<p>Next you'll need to set the DNS IP for all the networks that you've setup as follows:
Go to each network and set the DNS IP to the DNS Server (in my case it's 192.168.1.2):</p>
<p><img src="//images.ctfassets.net/ifshb5hrrgy8/3VucMvIh4TNg8rMxdHHfRh/3e19d2864fc30ee5de72b4e0420367ad/image.png" alt="DNS settings for network"></p>
<p>Make sure that <strong>no</strong> content filtering settings have been set as this will interfere with DNS queries.
<img src="//images.ctfassets.net/ifshb5hrrgy8/66mYZHW0PvDC8vgZhsMORq/667614ff0298a85e2c3b8a45862c3d76/image.png" alt="Content filtering settings"></p>
<p>Save those settings.</p>


Configuring PiHole and Unifi for DNS content filtering

Configuring PiHole and Unifi for DNS

<h3>Configuration</h3>
<p>Setting up SonarQube &#x26; SonarCloud for Azure DevOps is straight-forward and can be done by following the steps outlined here:</p>
<p>SonarQube installation/setup: <a href="https://docs.sonarqube.org/latest/setup/install-server/" title="SonarQube setup documentation">https://docs.sonarqube.org/latest/setup/install-server/</a>  (SonarQube requires Java 11 or Docker to work depending on whether you are installation the zip file or docker image).</p>
<p>SonarCloud installtion/setup is far more trivial and is configured when creating an account.</p>
<h3>Continuous Integration</h3>
<p>Once the SonarQube/Cloud has been configured you then need to configure your DevOps pipeline. In order to do so you will need to install the relevant extension:
SonarQube: <a href="https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube">https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube</a>
SonarCloud: <a href="https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud">https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud</a> </p>
<p>Installing the SonarQube/Cloud extension will give you access to three tasks in DevOps:</p>
<ol>
<li>Prepare Analysis Configuration</li>
<li>Run Code Analysis</li>
<li>Publish Quality Gate Result</li>
</ol>
<ul>
<li>Instructions for SonarQube: <a href="https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-azure-devops/#header-3" title="SonarScanner setup for Azure Devops documentation">https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-azure-devops/#header-3</a> </li>
<li>Instructions for SonarCloud: <a href="https://sonarcloud.io/documentation/analysis/scan/sonarscanner-for-azure-devops/" title="SonarCloud setup for Azure Devops documentation">https://sonarcloud.io/documentation/analysis/scan/sonarscanner-for-azure-devops/#configure</a></li>
</ul>
<p>The configuration process for the SonarQube/Cloud extensions are identical.</p>
<p>For the purposes of this work I have manually added the sonar configuration settings, however I recommend adding the settings to a file called sonar-project.properties and storing that in git with the solution.</p>
<h3>Pipeline Process</h3>
<p>Once the extensions are configured the build pipeline needs to be updated so that the analysis can be reported to SonarQube/Cloud correctly.</p>
<p>The build process should have the following steps:</p>
<ol>
<li>Checkout solution</li>
<li>Install NodeJs</li>
<li>Run npm ci</li>
<li>Run the SonarQubePrepare/SonarCloudPrepare task</li>
<li>Run npm build</li>
<li>Run npm test</li>
<li>Run SonarQubeAnalyse/SonarCloudAnalyse task</li>
<li>Run SonarQubePublish/SonarCloudPublish task</li>
</ol>
<p>Below is a sample YAML pipeline.</p>
<pre><code class="language-yaml"># Node.js
# Build a general Node.js project with npm.
# Add steps that analyze code, save build artifacts, deploy, and more:
# https://docs.microsoft.com/azure/devops/pipelines/languages/javascript

trigger:
- master

pool:
  vmImage: 'ubuntu-latest'

steps:
- task: NodeTool@0
  inputs:
    versionSpec: '10.x'
  displayName: 'Install Node.js'

 - script: |
     npm run lint
   displayName: 'npm lint'

- script: |
    npm ci
  displayName: 'npm ci'

- task: SonarCloudPrepare@1
  inputs:
    SonarCloud: 'SonarCloud'
    organization: '[ORGANISATION_NAME]' #this will come from setup
    scannerMode: 'CLI'
    configMode: 'manual'
    cliProjectKey: '[PROJECT_KEY_NAME]' #this will come from setup
    cliProjectName: '[PROJECT_NAME]' #this will come from setup
    cliSources: [COMMA_SEPARATED_LIST_OF_FOLDERS_TO_COVER] #e.g.'components,lib,pages,utils'
    extraProperties: |
      sonar.testExecutionReportPaths=test-report.xml
      sonar.javascript.lcov.reportPaths=coverage/lcov.info

- script: |
    npm run build
  displayName: 'npm build'

- script: |
    npm run test
  displayName: 'npm run test'

- task: SonarCloudAnalyze@1

- task: SonarCloudPublish@1
  inputs:
    pollingTimeoutSec: '300'

- task: PowerShell@2
  displayName: SonarCloud Result
  inputs:
    targetType: 'inline'
    script: |
      $token = [System.Text.Encoding]::UTF8.GetBytes([AUTHORISATION_TOKEN] + ":")
      $base64 = [System.Convert]::ToBase64String($token)

      $basicAuth = [string]::Format("Basic {0}", $base64)
      $headers = @{ Authorization = $basicAuth }

      $result = Invoke-RestMethod -Method Get -Uri https://sonarcloud.io/api/qualitygates/project_status?projectKey=[PROJECT_NAME] -Headers $headers
      $result | ConvertTo-Json | Write-Host

      if ($result.projectStatus.status -eq "OK") {
      Write-Host "Quality Gate Succeeded"
      }else{
      throw "Quality gate failed"
      }

- task: CopyFiles@2
  displayName: "Copy Output Directory"
  inputs:
    Contents: |
        **
        !.git/**/*
        !debug.log
    targetFolder: $(Build.ArtifactStagingDirectory)
</code></pre>
<p>Solution Setup</p>
<p>In order for SonarQube/Cloud to analyse the code correct there are a couple steps that need to be taken.
The following packages need to be installed into the solution's dev dependencies:</p>
<pre><code class="language-json">  "devDependencies": {
    "@babel/core": "^7.12.3",
    "@babel/plugin-transform-react-jsx": "^7.12.1",
    "@babel/preset-env": "^7.12.1",
    "@typescript-eslint/eslint-plugin": "^4.5.0",
    "@typescript-eslint/parser": "^4.5.0",
    "babel-jest": "^26.6.1",
    "eslint": "^7.12.1",
    "eslint-plugin-jest": "^24.1.0",
    "eslint-plugin-react": "^7.21.5",
    "eslint-plugin-prettier": "^3.1.4",
    "eslint-plugin-react": "^7.21.5",
    "jest": "^26.6.1",
    "jest-sonar-reporter": "^2.0.0"
  }
</code></pre>
<p>You need to add a jest.config.js file with the following contents:</p>
<pre><code class="language-json">/*
 * For a detailed explanation regarding each configuration property, visit:
 * https://jestjs.io/docs/en/configuration.html
 */

module.exports = {

  // Automatically clear mock calls and instances between every test
  clearMocks: true,

  /*
   * Indicates whether the coverage information should be collected while executing the test
   */
   collectCoverage: true,

  // The directory where Jest should output its coverage files
  coverageDirectory: 'coverage',

  // The test environment that will be used for testing
  testEnvironment: 'node',

  /*
   * This option allows the use of a custom results processor
   */
  testResultsProcessor: 'jest-sonar-reporter'

};
</code></pre>
<p>You will need to configure babel correctly - below is a sample configuration in babel.config.js</p>
<pre><code class="language-json">module.exports = {
    presets: [
        [
            '@babel/preset-env',
            { 
                targets: { 
                    node: 'current' 
                } 
            }
        ]
    ],
    plugins: ['@babel/plugin-transform-react-jsx']
  };
</code></pre>
<p>All these files should be stored with the root of the solution.</p>


Using & configuring SonarCloud code analysis on a nodeJs project for static code anaylsis.

M is for Mackolicious

Developer

Blogger

Services