Merge pull request 'Добавление лабораторной работы 2' (#11) from lw2 into main

Reviewed-on: http://student.git.athene.tech/v.moiseev/distributed-computing/pulls/11

README.md

@@ -6,7 +6,7 @@
 ## Лабораторные работы
 
 1. [Знакомство с docker и docker-compose](labs/lab_1/README.md)
-2. TBA
+2. [Разработка простейшего распределённого приложения](labs/lab_2/README.md)
 3. TBA
 4. TBA
 5. TBA

labs/lab_2/README.md

@@ -0,0 +1,113 @@
+# Лабораторная работа №2 - Разработка простейшего распределённого приложения
+
+**Цель**: изучение техники создания простого распределённого приложения.
+
+**Задачи**:
+
+1. **Согласно вашему варианту** разработать два приложения такие, что результат первого является исходными данными для второго.
+2. Изучить файлы сборки образов docker и разработать их для созданных приложений.
+3. Собрать файл `docker-compose.yml` для запуска приложений.
+   Разобраться с монтированием каталогов из хост-системы.
+4. Правильно закоммитить результат без лишних файлов.
+5. Оформить pull request по правилам и отправить его на проверку.
+
+## Разработка двух приложений
+
+Необходимо разработать 2 приложения согласно варианту.
+Описание поиска своего варианта расположено ниже.
+
+Общее для всех вариантов:
+
+* Язык разработки приложений — любой.
+* Содержимое исходных файлов - целые числа.
+* Результат выполнения программы 2 необходимо дополнительно вывести на экран.
+
+> Автор советует использовать dotnet, java, go или python.
+
+Каждая программа должна лежать в отдельной подпапке в репозитории, например: `tasks/moiseev-vv/lab_2/worker-1` и `tasks/moiseev-vv/lab_2/worker-2`.
+
+[Пример от автора](../../tasks/moiseev-vv/lab_2/).
+
+## Добавление файлов сборки `Dockerfile`
+
+В каталоге с каждым приложением необходимо создать файл `Dockerfile`, где будут расположены инструкции по сборке образа с вашими приложениями.
+
+> Для многих языков программирования шаблоны `Dockerfile` можно найти в Интернете.
+
+В рамках задания необходимо расписать, за что отвечает каждая значимая строка в `Dockerfile`.
+Хотя бы одном.
+
+Если у вас используется multi-stage build (как в примере выше, где в одном `Dockerfile` несколько конструкций `FROM`), необходимо расписать, зачем.
+
+## Формирование файла `docker-compose.yml`
+
+Необходимо в каталоге с вашей работой создать файл `docker-compose.yml`, чтобы можно было собрать и запустить программы следующей командой:
+
+```
+distributed-computing\tasks\moiseev-vv\lab_2$ docker compose up --build
+```
+
+> До `$` - каталог относительно корня репозитория, чтобы понять, откуда запускается `docker compose`.
+
+Необходимо, чтобы в файле было:
+
+1. Два сервиса.
+   Каждый соответствует вашим программам.
+2. Объявлена директива `build` для каждого сервиса.
+3. Была работа с монтированием папок.
+4. Были описаны зависимости одного сервиса от другого.
+
+## Оформление отчёта
+
+Правила именования папки с отчётом и исходными текстами - `/tasks/фамилия-инициалы/lab_номер`, например, `/tasks/moiseev-vv/lab_2`.
+
+[Пример отчёта и всего остального](../../tasks/moiseev-vv/lab_2/README.md).
+
+## Коммит результата
+
+Перед началом работы над задачей необходимо актуализировать свой форк, выполненный в работе №1.
+
+Как это сделать зависит от конкретного хранилища git-репозиториев.
+
+> TODO: Так как всё-таки?!
+
+Также необходимо не забыть добавить файл `.gitignore` в каталог с вашей работой.
+Если вы этого не сделаете, на коммит "полезут" файлы сборки и прочие вещи, который быть в публичном репозитории не должны.
+
+> Для `dotnet` файл `.gitignore` создаётся при помощи команды `dotnet new gitignore`.
+
+Правила именования ветки: `фамилия-инициалы-lab-номер`, например, `moiseev-vv-lab-2`.
+
+## Правила оформления pull request
+
+Название pull request: `[Л/Р 2] ФАМИЛИЯ ИМЯ`, например, `[Л/Р 2] Моисеев Владислав`.
+
+## Варианты
+
+Расчёт варианта также представляет собой задачку:
+
+1. Необходимо найти номер своей зачёткой книжки.
+   Пусть будет _20/614_.
+2. Далее необходимо найти **остаток от деления номера на 7**.
+   Это будет вариант для программы 1.
+   В нашем примере это `614 : 7 = 87 и остаток` **5**.
+3. Вариант для программы 2 - **остаток от деления номера зачётки на 5**
+   В нашем случае это `614 : 5 = 122 и остаток` **4**.
+
+### Варианты программы 1:
+
+0. Ищет в каталоге `/var/data` самый большой по объёму файл и перекладывает его в `/var/result/data.txt`.
+1. Ищет в каталоге `/var/data` файл с наибольшим количеством строк и перекладывает его в `/var/result/data.txt`.
+2. Формирует файл `/var/result/data.txt` из первых строк всех файлов каталога `/var/data`.
+3. Формирует файл `/var/result/data.txt` так, что каждая строка файла - количество строк в файлах из каталога `/var/data`.
+4. Формирует файл `/var/result/data.txt` так, что каждая строка файла - количество символов в именах файлов из каталога `/var/data`.
+5. Ищет в каталоге `/var/data` файл с самым коротким названием и перекладывает его в `/var/result/data.txt`.
+6. Берёт из каталога `/var/data` случайный файл и перекладывает его в `/var/result/data.txt`.
+
+### Варианты программы 2:
+
+0. Сохраняет произведение первого и последнего числа из файла `/var/data/data.txt` в `/var/result/result.txt`.
+1. Ищет набольшее число из файла `/var/data/data.txt` и сохраняет его вторую степень в `/var/result/result.txt`.
+2. Ищет наименьшее число из файла `/var/data/data.txt` и сохраняет его третью степень в `/var/result/result.txt`.
+3. Ищет набольшее число из файла `/var/data/data.txt` и сохраняет количество таких чисел из последовательности в `/var/result/result.txt`.
+4. Ищет наименьшее число из файла `/var/data/data.txt` и сохраняет количество таких чисел из последовательности в `/var/result/result.txt`.

tasks/moiseev-vv/lab_2/.dockerignore

@@ -0,0 +1,2 @@
+*/*/bin
+*/*/obj

tasks/moiseev-vv/lab_2/.gitignore

@@ -0,0 +1,481 @@
+## Наши данные для работы программы
+result-1/
+result/ 
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# Tye
+.tye/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.tlog
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+*.ncb
+*.aps
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# Visual Studio History (VSHistory) files
+.vshistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml
+
+##
+## Visual studio for Mac
+##
+
+
+# globs
+Makefile.in
+*.userprefs
+*.usertasks
+config.make
+config.status
+aclocal.m4
+install-sh
+autom4te.cache/
+*.tar.gz
+tarballs/
+test-results/
+
+# Mac bundle stuff
+*.dmg
+*.app
+
+# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

tasks/moiseev-vv/lab_2/README.md

@@ -0,0 +1,74 @@
+# Отчёт по лабораторной работе №1
+
+Выполнил: студент гр. ИСТбд-41 Моисеев Владислав.
+
+Вариант программы 1: Формирует файл `/var/result/data.txt` из содержимого всех файлов каталога `/var/data`.
+
+Вариант программы 2: Сохраняет сумму чисел из файла `/var/data/data.txt` в `/var/result/result.txt`.
+
+## Создание приложений
+
+Создадим 2 приложения.
+Был выбран язык C# и технология .NET 7, потому что хочется.
+
+Для создания обычных консольных приложений воспользуемся командами:
+
+```sh
+dotnet new console -o worker-1
+dotnet new console -o worker-2
+```
+
+Согласно варианту программа 1 должна брать все файлы из папки `/var/data`, считывать оттуда строки и укладывать их в файл `/var/result/data.txt`.
+
+[Исходный текст программы worker-1](worker-1/Program.cs)
+
+Согласно варианту программа 2 должна брать строки из файла `/var/data/data.txt`, пытаться привести их к числам, а затем заниматься их сложением.
+Затем результат вычислений копируется в файл `/var/result/result.txt`.
+
+[Исходный текст программы worker-2](worker-2/Program.cs)
+
+Дополнительно создан файл [.gitignore](.gitignore) для того, чтобы не закоммитить в git ничего лишнего.
+
+## Настройка окружения
+
+Для связи двух приложений воспользуемся следующей схемой:
+
+1. Каталог `./data` должен быть примонтирован в каталог `/var/data` для программы 1.
+   Оттуда будут браться исходные данные.
+2. Каталог `./result-1` должен быть примонтирован в каталог `/var/result` для программы 2.
+   Туда будут складываться промежуточные данные.
+3. Каталог `./result-1` также должен быть примонтирован в каталог `/var/data` для программы 2.
+   Оттуда будут браться промежуточные результаты.
+4. Каталог `./result` должен быть примонтирован в каталог `/var/result` для программы 2.
+   Туда будут складывать результаты финальной обработки.
+
+Для каждой программы были созданы файлы Dockerfile ([программа 1](worker-1/Dockerfile), [программа 2](worker-1/Dockerfile)) с подробным описанием процесса сборки.
+
+Был создан файл [docker-compose.yml](docker-compose.yml), в котором указан манифест для запуска распределённого приложения.
+
+Дополнительно был создан файл [.dockerignore](.dockerignore) и дополнен [.gitignore](.gitignore), чтобы исключить для сборки и коммита всё лишнее.
+
+## Сборка и запуск
+
+В каталог `./data` помещены 2 файла.
+Сумма чисел в первом - 10, во втором - 40.
+
+Для запуска приложения необходимо ввести команду `docker compose up ---build`.
+
+Результат запуска после сборки:
+
+```
+[+] Running 2/0
+ - Container lab_2-worker-1-1  Created
+ - Container lab_2-worker-2-1  Created
+Attaching to lab_2-worker-1-1, lab_2-worker-2-1
+lab_2-worker-1-1  | Начало обработки файла /var/data/another data.txt
+lab_2-worker-1-1  | Начало обработки файла /var/data/data.txt
+lab_2-worker-1-1 exited with code 0
+lab_2-worker-2-1  | Чисел для обработки: 8
+lab_2-worker-2-1 exited with code 0
+```
+
+В результате в каталоге `./result` создался файл `result.txt` с содержимым `50`, что соответствует входным данным.
+
+Изменение значений в файлах из каталога `./data` также изменяет содержимое в файлах из каталогов `./result-1` и `./result`.

tasks/moiseev-vv/lab_2/data/another data.txt

@@ -0,0 +1,4 @@
+10
+10
+10
+10

tasks/moiseev-vv/lab_2/data/data.txt

@@ -0,0 +1,4 @@
+1
+2
+3
+4

tasks/moiseev-vv/lab_2/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.1"
+services:
+  worker-1:
+    build: ./worker-1
+    volumes:
+      - ./data:/var/data
+      - ./result-1:/var/result
+  worker-2:
+    build: ./worker-2
+    volumes:
+      - ./result-1:/var/data
+      - ./result:/var/result
+    depends_on:
+      - worker-1

tasks/moiseev-vv/lab_2/worker-1/Dockerfile

@@ -0,0 +1,11 @@
+FROM mcr.microsoft.com/dotnet/sdk:7.0 AS build-env
+WORKDIR /app
+
+COPY . ./
+RUN dotnet restore
+RUN dotnet publish -c Release -o out
+
+FROM mcr.microsoft.com/dotnet/aspnet:7.0
+WORKDIR /app
+COPY --from=build-env /app/out .
+ENTRYPOINT ["dotnet", "worker-1.dll"]

tasks/moiseev-vv/lab_2/worker-1/Program.cs

@@ -0,0 +1,9 @@
+List<string> numbers = new();
+
+foreach (var file in Directory.GetFiles("/var/data"))
+{
+    Console.WriteLine("Начало обработки файла " + file);
+    numbers.AddRange(File.ReadAllLines(file));
+}
+
+File.WriteAllLines("/var/result/data.txt", numbers);

tasks/moiseev-vv/lab_2/worker-1/worker-1.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+    <RootNamespace>worker_1</RootNamespace>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>

tasks/moiseev-vv/lab_2/worker-2/Dockerfile

@@ -0,0 +1,11 @@
+FROM mcr.microsoft.com/dotnet/sdk:7.0 AS build-env
+WORKDIR /app
+
+COPY . ./
+RUN dotnet restore
+RUN dotnet publish -c Release -o out
+
+FROM mcr.microsoft.com/dotnet/aspnet:7.0
+WORKDIR /app
+COPY --from=build-env /app/out .
+ENTRYPOINT ["dotnet", "worker-2.dll"]

tasks/moiseev-vv/lab_2/worker-2/Program.cs

@@ -0,0 +1,10 @@
+string[] numbers = File.ReadAllLines("/var/data/data.txt");
+Console.WriteLine("Чисел для обработки: " + numbers.Length);
+long sum = 0;
+foreach (var numberStr in numbers)
+{
+    if (!int.TryParse(numberStr, out int number))
+        throw new ArgumentException("Wrong number " + numberStr);
+    sum += number;
+}
+File.WriteAllText("/var/result/result.txt", sum.ToString());

tasks/moiseev-vv/lab_2/worker-2/worker-2.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+    <RootNamespace>worker_2</RootNamespace>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>